Product Docs

Engineering Blog

Census API Reference

API Reference

Back to Census

Get help

Learn how to embed Census Reverse ETL in your customer-facing application so you can focus on your core business

Overview

Census

Introduction

This guide will walk you through the key concepts of Census Embedded and how to get started syncing your customer's data

Quickstart Guide

An introduction to Census' Management APIs

Pagination

Authentication

Get user details for all users in the current organization.

List users

Fetch user

Remove user

Update a user's role within the organization.

Update user role

Get details for all claimed and unclaimed invitations in the current organization.

List invitations

Retrieve details of a specific invitation.

Fetch invitation

Update an unclaimed invitation's role within the organization.

Update invitation

Revoke an unclaimed invitation so it can no longer be used.

Revoke invitation

Resend the email for an unclaimed invitation.

Resend invitation

Get details for all workspaces in the current organization.

List workspaces

Create a new workspace in the current organization.

Create workspace

Retrieve the details of a specific workspace.

Fetch workspace

Delete a specific workspace and all of its associated objects. Be very careful!

Delete workspace

Update workspace

List Syncs

Create a new sync

Fetch sync

Delete a sync

Update certain configurable attributes of a sync

Update a sync

Triggers the sync with the specified ID to start a new sync run.

Trigger a sync run

List sync runs

Retrieve the details of a particular sync run

Fetch sync run

Use this endpoint to cancel a sync that is actively running.

Cancel a running sync

Use this endpoint to list out the types of destination connections that can be created in the current workspace. This is particularly useful for Census Embedded solutions when determining the required values to authorize a new destination connection.

List connectors

Use this endpoint to fetch the details for a specific types of destination connection that can be created in the current workspace. This is particularly useful for Census Embedded solutions when determining the required values to authorize a new destination connection.

Fetch connector

List destinations

Create a new destination

Fetch destination

Delete destination

Update destination

This endpoint queues a job to refresh the list of objects for a destination.

Start object refresh

This endpoint checks whether the job refreshing objects for a destination has completed.

Check object refresh

List destination objects

This endpoint lists information for a given object, including information on what fields it includes.

Fetch destination object

This endpoint queues a job to refresh the list of fields for a given destination object.

Start fields refresh

This endpoint checks whether the job refreshing fields for a destination object has completed.

Check fields refresh

This endpoint returns details for all active and expired connect links in the current workspace.

List destination connect links

Create a new destination connect link

This endpoint returns a list of all the types of supported destination connect links. Note that there may be a few missing that are available via the connectors metadata API. If you wish to use one of these, please reach out to us.

List destination connect link types

Retrieve the details of a specific destination connect link

Fetch destination connect link

Revokes a destination connect link so that it can no longer be used.

Revoke a destination connect link

List sources

Create a new source

Fetch source

Delete source

Update source

This endpoint queues a job to refresh the list of tables for a source.

Start table refresh

This endpoint checks whether the job refreshing tables for a source has completed.

Getting Started

Census Embedded

Overview

What is Census Embedded?

How can I use Census Embedded?

Getting Started

Census Embedded

​What is Census Embedded?

​How can I use Census Embedded?

What is Census Embedded?

How can I use Census Embedded?