List destination objects

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.

Show child attributes

pagination.total_records

number

Total records in the collection.

Example:

14

pagination.per_page

number

default:25

Records on each page.

Example:

25

pagination.prev_page

number | null

The previous page number, or null for the first page.

Example:

1

pagination.page

number

default:1

The current page number.

Example:

2

pagination.next_page

number | null

The next page number, or null if it's the last page.

Example:

3

pagination.last_page

number

The number of the last page with records.

Example:

10

data

object[]

required

The list of results.

Show child attributes

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.advanced_configuration_field_definitions

object[]

An array of advanced configuration options for this object. Returns an empty array for destinations that don't support advanced configuration. Configuration options should be defined when creating syncs to this object via the advanced_configuration attribute in the create sync payload.

Show child attributes

data.advanced_configuration_field_definitions.name

string

required

The unique identifier for this field.

data.advanced_configuration_field_definitions.type

enum<string>

required

The data type of this field.

Available options:

string,

integer,

boolean,

object

data.advanced_configuration_field_definitions.label

string

required

The human-readable label for this field.

data.advanced_configuration_field_definitions.input_type

enum<string>

required

The type of input control to use for this field.

Available options:

text,

radio,

toggle,

checkbox,

dropdown,

textarea

data.advanced_configuration_field_definitions.sort_order

integer

The order in which this field should be displayed.

data.advanced_configuration_field_definitions.placeholder

string

Placeholder text for the input field.

data.advanced_configuration_field_definitions.default

any

The default value for this field. Type varies based on the field type.

data.advanced_configuration_field_definitions.required

boolean

Whether this field is required to be provided.

data.advanced_configuration_field_definitions.supported_values

any[]

Valid values for this field (typically used with dropdown input_type). Array items can be strings, integers, or other types.

data.advanced_configuration_field_definitions.immutable_after_create

boolean

Whether this field cannot be changed after the initial creation.

data.advanced_configuration_field_definitions.show_when

object

Conditional logic for when to show this field based on other field values.

Example:

{ "file_format": ["CSV", "TSV"] }

data.advanced_configuration_field_definitions.read_more

string

URL to documentation providing more information about this field.

data.advanced_configuration_field_definitions.operations

string[]

Operations where this field is applicable (e.g., merge, overwrite).

Example:

[
  {
    "name": "http_endpoint",
    "type": "string",
    "label": "HTTP Endpoint",
    "input_type": "text",
    "placeholder": "/users",
    "sort_order": 1,
    "required": true
  },
  {
    "name": "batch_size",
    "type": "integer",
    "label": "Batch Size",
    "input_type": "textarea",
    "placeholder": "",
    "default": 1,
    "sort_order": 2
  },
  {
    "name": "http_method",
    "type": "string",
    "label": "HTTP Method",
    "input_type": "dropdown",
    "default": "POST",
    "sort_order": 3,
    "supported_values": ["POST", "PUT", "PATCH", "DELETE", "GET"]
  }
]

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.

Show child attributes

data.fields.label

string

The label for this field.

Example:

"External User ID"

data.fields.full_name

string

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

Example:

"external_id"

data.fields.createable

boolean

Whether or not this field can be created in the destination if it doesn't exist.

Example:

true

data.fields.updateable

boolean

Whether or not this field can be updated in the destination.

Example:

true

data.fields.operations

enum<string>[]

For an array type, what operations are supported on this field. One of the following types:

overwrite: Overwrite existing values with inputted values
merge: Merge inputted values with existing values

Available options:

overwrite,

merge

data.fields.array

boolean

Whether or not this field is an array type.

data.fields.preserve_values_supported

boolean

If a value exists in the destination for this field, whether or not it can be overwritten by Census.

Example:

true

data.fields.required_for_mapping

boolean

Whether or not this field is required.

Example:

true

data.fields.can_be_upsert_key

boolean

Whether or not this field can be the primary identifier for an upsert sync.

Example:

true

data.fields.can_be_update_key

boolean

Whether or not this field can be the primary identifier for an update only sync.

Example:

true

data.fields.can_be_insert_key

boolean

Whether or not this field can be the primary identifier for a create only sync.

Example:

true

data.fields.can_be_reference_key

boolean

Whether or not this field can be the identifier for a lookup on its containing object.

Example:

true

data.fields.lookup_object

string

What object, if any, that this field references.

Example:

"company"

data.fields.type

string

The type of this field.

Example:

"string"

data.configurable_field_definitions

object

deprecated

DEPRECATED: A simplified map of configurable field definitions for this object, containing only the field types (e.g., {"http_endpoint": "string", "batch_size": "integer"}). This field is deprecated in favor of advanced_configuration_field_definitions, which provides complete field definitions including all attributes such as label, input_type, placeholder, sort_order, validation rules, and inclusion constraints. Please use advanced_configuration_field_definitions for new integrations.

Show child attributes

data.configurable_field_definitions.{key}

string

Example:

{
  "http_endpoint": "string",
  "batch_size": "integer"
}

Introduction

Organization APIs

Workspace APIs

Authorizations

Path Parameters

Query Parameters

Response