List destination objects

GET

destinations

{destination_id}

objects

curl --request GET \
  --url https://app.getcensus.com/api/v1/destinations/{destination_id}/objects \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "pagination": {
    "total_records": 14,
    "per_page": 25,
    "prev_page": 1,
    "page": 2,
    "next_page": 3,
    "last_page": 10
  },
  "data": [
    {
      "label": "User",
      "full_name": "user",
      "supported_operations": [
        "insert",
        "update",
        "upsert"
      ],
      "allow_custom_fields": true,
      "allow_case_sensitive_fields": true,
      "supports_field_ordering": false,
      "can_be_sync_destination": true,
      "fields": [
        {
          "label": "External User ID",
          "full_name": "external_id",
          "createable": true,
          "updateable": true,
          "operations": [
            "overwrite"
          ],
          "array": true,
          "preserve_values_supported": true,
          "required_for_mapping": true,
          "can_be_upsert_key": true,
          "can_be_update_key": true,
          "can_be_insert_key": true,
          "can_be_reference_key": true,
          "lookup_object": "company",
          "type": "string"
        }
      ]
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.

Path Parameters

destination_id

integer

required

ID of the destination

Query Parameters

page

number

default:1

Designates which page of results to return. Always starts at 1. If 0 is specified, it defaults to 1.

per_page

number

default:25

Determines the number of results on each page. It can't exceed 100.

Required range: x <= 100

order

enum<string>

default:desc

Organizes the results based on their creation time, either ascending or descending.

Available options:

asc,

desc

Response

200 - application/json

Successfully retrieved the list of destination objects.

A successfully fetched list of results.

status

enum<string>

required

The outcome of the request

Available options:

success

Example:

"success"

pagination

object

required

An object to help you navigate the list of results.

data

object[]

required

The list of results.

data.label

string

The label for this object.

Example:

"User"

data.full_name

string

The full name for this object. This is used to identify the object in the API.

Example:

"user"

data.supported_operations

enum<string>[]

A list of the operations this object supports when being synced to.

Available options:

append,

insert,

mirror,

update,

upsert

Example:

["insert", "update", "upsert"]

data.allow_custom_fields

boolean

Whether or not you can define custom fields on this object.

Example:

true

data.allow_case_sensitive_fields

boolean

Whether or not field names and labels are case sensitive on this object.

Example:

true

data.supports_field_ordering

boolean

Whether or not you can set the field_order attribute on a sync to this object. Valid field_order configurations are alphabetical_column_name and mapping_order.

Example:

false

data.can_be_sync_destination

boolean

Whether or not you can create a sync to this object. This will be false if the object has been deleted.

Example:

true

data.fields

object[]

A list of fields associated with this destination.

A field available on a destination object that can be mapped to.

Was this page helpful?

Raise issue

Check object refresh Create a new destination object

curl --request GET \
  --url https://app.getcensus.com/api/v1/destinations/{destination_id}/objects \
  --header 'Authorization: Bearer <token>'

{
  "status": "success",
  "pagination": {
    "total_records": 14,
    "per_page": 25,
    "prev_page": 1,
    "page": 2,
    "next_page": 3,
    "last_page": 10
  },
  "data": [
    {
      "label": "User",
      "full_name": "user",
      "supported_operations": [
        "insert",
        "update",
        "upsert"
      ],
      "allow_custom_fields": true,
      "allow_case_sensitive_fields": true,
      "supports_field_ordering": false,
      "can_be_sync_destination": true,
      "fields": [
        {
          "label": "External User ID",
          "full_name": "external_id",
          "createable": true,
          "updateable": true,
          "operations": [
            "overwrite"
          ],
          "array": true,
          "preserve_values_supported": true,
          "required_for_mapping": true,
          "can_be_upsert_key": true,
          "can_be_update_key": true,
          "can_be_insert_key": true,
          "can_be_reference_key": true,
          "lookup_object": "company",
          "type": "string"
        }
      ]
    }
  ]
}

Introduction

Organization APIs

Workspace APIs

Authorizations

Path Parameters

Query Parameters

Response