Product Docs

Engineering Blog

Census API Reference

API Reference

Back to Census

Get help

Pagination

Introduction

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

Overview

This guide will walk you through securely collecting customer credentials via Connect Links.

Connect Links

This guide will walk you through the available custom branding options for Census Embedded customers.

Custom Branding

This guide will walk you through embedding pieces of Census UI into your own application.

Embeddable UI Components

Use Census with Custom Destinations to create a connection to any destination service of your choice.

Destination Spec

Publish your Custom Destination to your workspace or organization for convenient repeated use.

Scoped Destinations

Publish your Custom Destination as an officially registered destination, available for all Census users.

Partner Destinations

Unleash your semantic graph and use your data to power apps far beyond your data warehouse.

Guide

Manage Census SQL models and syncs via YAML files in your Git repository.

An introduction to Census' Management APIs

Authentication

Paginated list of all user details for 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

Create a new invitation for a user to join the current organization.

Create 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

Retrieve the details of the workspace authenticated with the current Workspace API Token.

Fetch authenticated workspace

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

Delete workspace

Update workspace

List workspace users

Invite a user to a workspace. If the user already exists in the organization they will be automatically added to the workspace.

Invite user to workspace

Update the role of a workspace user. Throws 403 if Access Controls are not available for the organization.

Update workspace user

Removes a specific user from the workspace. Does not delete the user from the organization

Delete workspace user

Get details for all invitations for a specific workspace.

List workspace invitations

Update the role for an unclaimed invitation to a workspace. Throws 403 if Access Controls are not available for the organization.

Update workspace invitation

Removes a specific invitation to a workspace for a given user.

Revoke workspace invitation

List Syncs

Create a new sync

Fetch sync

Delete a sync

Update certain configurable attributes of a sync. Note that though this endpoint is a `PATCH` and top level attributes respect patch semantics, this does not apply to nested objects. Any nested objects that are changed must be sent in full, including any unchanged values.

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 retrieve a sample of skipped records for a specific sync run.
The endpoint will redirect to a temporary S3 URL where the JSON file contents can be accessed.
Clients should follow the redirect to retrieve the JSON data.

This is initially a 302 redirect to the skipped records file, and if followed ultimately returns a 200 with the JSON data in the response. The schema of the return will vary depending on the fields used in the sync. The sync key will be used to identify a record with an `error_message`. Additional properties will be returned matching the fields used in the sync.

The endpoint may also return a 410 if the skipped records file is no longer available. You can read more about how we handle skipped records and our [policy on expiration: here](https://docs.getcensus.com/basics/security-and-privacy#step-4-report-skipped-records-and-feedback-to-warehouse).


Fetch sample skipped records

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 destination types

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 destination type

Create a new destination type for your given workspace. By default the destination type is created and scoped just to your workspace and not visible to other workspaces or orgs. See [Scoped Destinations](/custom-destinations/scoped-destinations) and [Partner Destinations](/custom-destinations/partner-destinations) for more information on how to create destination types that are visible to other workspaces or orgs.

Create a new destination type

Update a specific destination type by service name. You must be an owner of the destination type and it must not be published in order to update. If you wish to update a published destination type please reach out to Census Support.

Update destination type

Publish a destination type to the organization. This will make the destination type available to all workspaces in the organization. You must be an owner of the destination type and it must not be already published. See [Scoped Destinations](/custom-destinations/scoped-destinations) for more details. For information on publishing to all Census customers, see [Partner Destinations](/custom-destinations/partner-destinations).

Publish destination type to organization

Delete a specific destination type by service name. You must be an owner of the destination type and it must not be published in order to delete. If you wish to delete a published destination type please reach out to Census Support.

Delete destination type

List destinations

This endpoint can be used to create destinations in Census. Each destination requires a different set of credentials in the request payload. 
The credentials needed to create each type of connection can be found in the `GET /connectors` API for most destinations. For OAuth destinations, see this [Notion doc](https://getcensus.notion.site/Headless-OAuth-Destinations-4b282c9944fe4fa3a5d76d874f0c3d5f).


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

List destination object types

This endpoint can be used to create objects in a destination. Each object requires object attributes and field attributes
which are unique to the destination. The object attributes and field attributes can be found in the `GET /destinations/{destination_id}/object_types` API.


Create a new destination object

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

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

This link URI is used to reauthorize your destination.

Create connect link to reauthorize destination

List source types

Use this endpoint to fetch the details for a specific type of source 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 source connection.

Fetch source type

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.

Parameter	Type	Default	Description
`page`	number	1	Designates which page of results to return. Always starts at 1. If 0 is specified, it defaults to 1.
`per_page`	number	25 (max 100)	Determines the number of results on each page. It can’t exceed 100.
`order`	`asc` or `desc`	`desc`	Organizes the results based on their creation time, either ascending or descending.

Field	Type	Description
`total_records`	number	Total records in the collection.
`per_page`	number	Records on each page.
`prev_page`	number	The previous page number, or `null` for the first page.
`page`	number	The current page number.
`next_page`	number	The next page number, or `null` if it’s the last page.
`last_page`	number	The number of the last page with records.

Introduction

Organization APIs

Workspace APIs

Pagination

Request URL Parameters

Introduction

Organization APIs

Workspace APIs

​Request URL Parameters

​Response Pagination Data

Request URL Parameters

Response Pagination Data