Destination Objects

GET /destinations/[ID]/objects
This endpoint lists information for all objects under a given destination.
See Pagination for standard URL parameters and response data.
Request
Response
curl 'https://app.getcensus.com/api/v1/destinations/[ID]/objects' \
--header 'Authorization: Bearer [API_TOKEN]'
{
    "status": "success",
    "data": [
        {
            "label": "User",
            "full_name": "user",
            "supported_operations": ["upsert", "delete", "mirror"],
            "allow_custom_fields": true,
            "allow_case_sensitive_field_names": true,
            "fields": [
                {
                    "label": "First Name",
                    "full_name": "first_name",
                    "createable": true,
                    "updateable": true,
                    "operations": [],
                    "array": false,
                    "preserve_values_supported": false,
                    "required_for_mapping": false,
                    "can_be_upsert_key": false,
                    "can_be_update_key": false,
                    "can_be_insert_key": false,
                    "can_be_reference_key": false,
                    "lookup_object": null,
                    "type": "String"
                },
                {
                    "label": "Last Name",
                    "full_name": "last_name",
                    "createable": true,
                    "updateable": true,
                    "operations": [],
                    "array": false,
                    "preserve_values_supported": false,
                    "required_for_mapping": false,
                    "can_be_upsert_key": false,
                    "can_be_update_key": false,
                    "can_be_insert_key": false,
                    "can_be_reference_key": false,
                    "lookup_object": null,
                    "type": "String"
                },
                {
                    "label": "Company",
                    "full_name": "company",
                    "createable": true,
                    "updateable": true,
                    "operations": [],
                    "array": false,
                    "preserve_values_supported": false,
                    "required_for_mapping": false,
                    "can_be_upsert_key": false,
                    "can_be_update_key": false,
                    "can_be_insert_key": false,
                    "can_be_reference_key": false,
                    "lookup_object": "company",
                    "type": "String"
                },
                {
                    "label": "External User ID",
                    "full_name": "external_id",
                    "createable": true,
                    "updateable": true,
                    "operations": [],
                    "array": false,
                    "preserve_values_supported": false,
                    "required_for_mapping": false,
                    "can_be_upsert_key": true,
                    "can_be_update_key": true,
                    "can_be_insert_key": true,
                    "can_be_reference_key": true,
                    "lookup_object": null,
                    "type": "String"
                },
                {
                    "label": "Email",
                    "full_name": "email",
                    "createable": true,
                    "updateable": true,
                    "operations": [],
                    "array": false,
                    "preserve_values_supported": false,
                    "required_for_mapping": false,
                    "can_be_upsert_key": false,
                    "can_be_update_key": false,
                    "can_be_insert_key": false,
                    "can_be_reference_key": false,
                    "lookup_object": null,
                    "type": "String"
                }
            ]
        },
        {
            "label": "Organization",
            "full_name": "organization",
            "supported_operations": ["upsert", "mirror"],
            "allow_custom_fields": true,
            "allow_case_sensitive_field_names": true,
            "fields": [
                {
                    "label": "Name",
                    "full_name": "name",
                    "createable": true,
                    "updateable": true,
                    "operations": [],
                    "array": false,
                    "preserve_values_supported": false,
                    "required_for_mapping": false,
                    "can_be_upsert_key": false,
                    "can_be_update_key": false,
                    "can_be_insert_key": false,
                    "can_be_reference_key": false,
                    "lookup_object": null,
                    "type": "String"
                },
                {
                    "label": "Address",
                    "full_name": "address",
                    "createable": true,
                    "updateable": true,
                    "operations": [],
                    "array": false,
                    "preserve_values_supported": false,
                    "required_for_mapping": false,
                    "can_be_upsert_key": false,
                    "can_be_update_key": false,
                    "can_be_insert_key": false,
                    "can_be_reference_key": false,
                    "lookup_object": "company",
                    "type": "String"
                }
            ]
        }
    ],
    "next": "https://app.getcensus.com/api/v1/destinations/1/objects?page=2&per_page=2",
    "pagination": {
        "total_records": 3,
        "per_page": 2,
        "prev_page": null,
        "page": 1,
        "next_page": 2,
        "last_page": 2
    }
}
Data Property
Description
A list of destination objects
A list of objects for the given destination. The properties of each destination object are expanded on below in the GET /destinations/[ID] endpoint.
GET /destinations/[ID]/objects/[OBJECT_FULL_NAME]
This endpoint lists information for a given object, including information on what fields it includes.
Request
Response
curl 'https://app.getcensus.com/api/v1/destinations/[ID]/objects/[OBJECT_FULL_NAME]' \
--header 'Authorization: Bearer [API_TOKEN]'
{
    "status": "success",
    "data": {
        "label": "User",
        "full_name": "user",
        "supported_operations": ["upsert", "delete", "mirror"],
        "allow_custom_fields": true,
        "allow_case_sensitive_field_names": true,
        "fields": [
            {
                "label": "First Name",
                "full_name": "first_name",
                "createable": true,
                "updateable": true,
                "operations": [],
                "array": false,
                "preserve_values_supported": false,
                "required_for_mapping": false,
                "can_be_upsert_key": false,
                "can_be_update_key": false,
                "can_be_insert_key": false,
                "can_be_reference_key": false,
                "lookup_object": null,
                "type": "String"
            },
            {
                "label": "Last Name",
                "full_name": "last_name",
                "createable": true,
                "updateable": true,
                "operations": [],
                "array": false,
                "preserve_values_supported": false,
                "required_for_mapping": false,
                "can_be_upsert_key": false,
                "can_be_update_key": false,
                "can_be_insert_key": false,
                "can_be_reference_key": false,
                "lookup_object": null,
                "type": "String"
            },
            {
                "label": "Company",
                "full_name": "company",
                "createable": true,
                "updateable": true,
                "operations": [],
                "array": false,
                "preserve_values_supported": false,
                "required_for_mapping": false,
                "can_be_upsert_key": false,
                "can_be_update_key": false,
                "can_be_insert_key": false,
                "can_be_reference_key": false,
                "lookup_object": "company",
                "type": "String"
            },
            {
                "label": "External User ID",
                "full_name": "external_id",
                "createable": true,
                "updateable": true,
                "operations": [],
                "array": false,
                "preserve_values_supported": false,
                "required_for_mapping": false,
                "can_be_upsert_key": true,
                "can_be_update_key": true,
                "can_be_insert_key": true,
                "can_be_reference_key": true,
                "lookup_object": null,
                "type": "String"
            },
            {
                "label": "Email",
                "full_name": "email",
                "createable": true,
                "updateable": true,
                "operations": [],
                "array": false,
                "preserve_values_supported": false,
                "required_for_mapping": false,
                "can_be_upsert_key": false,
                "can_be_update_key": false,
                "can_be_insert_key": false,
                "can_be_reference_key": false,
                "lookup_object": null,
                "type": "String"
            }
        ]
    }
}
Data Property
Description
label
The label for this object.
full_name
The full name for this object. This is used to identify the object in the API.
supported_operations
A list of the operations this object supports when being synced to.
allow_custom_fields
Whether or not you can define custom fields on this object.
allow_case_sensitive_fields
Whether or not field names and labels are case sensitive on this object.
fields
A list of fields associated with this source. Field properties are described in the table below.
Field Properties
Data Property
Description
label
The label for this field.
full_name
The full name for this field. This is used to identify the field in the API.
createable
Whether or not this field can be created in the destination if it doesn't exist.
updateable
Whether or not this field can be updated in the destination.
operations
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
array
Whether or not this field is an array type.
preserve_values_supported
If a value exists in the destination for this field, whether or not it can be overwritten by Census.
required_for_mapping
Whether or not this field is required.
can_be_upsert_key
Whether or not this field can be the primary identifier for an upsert sync.
can_be_update_key
Whether or not this field can be the primary identifier for an update only sync.
can_be_insert_key
Whether or not this field can be the primary identifier for a create only sync.
can_be_reference_key
Whether or not this field can be the identifier for a lookup on its containing object.
lookup_object
What object, if any, that this field references.
type
The type of this field.
POST /destinations/[ID]/objects/[OBJECT_FULL_NAME]/refresh_fields
This endpoint queues a job to refresh the list of fields for a given destination object.
Request
Response
curl --request POST 'https://app.getcensus.com/api/v1/destinations/[ID]/objects/[OBJECT_FULL_NAME]/refresh_fields' \
--header 'Authorization: Bearer [API_TOKEN]'
{
    "refresh_key": 1647978948
}
Response Property
Description
refresh_key
Contains an id used to query the refresh objects job.
GET /destinations/[ID]/objects/[OBJECT_FULL_NAME]/refresh_fields_status
This endpoint checks whether the the job refreshing fields for a given destination object has completed.
Request
Response
curl 'https://app.getcensus.com/api/v1/destinations/[ID]/objects/[OBJECT_FULL_NAME]/refresh_fields_status?refresh_key=[refresh_key]' \
--header 'Authorization: Bearer [API_TOKEN]'
{
    "status": "completed"
}
Query Parameter
Description
refresh_key
required. An id provided by the refresh_objects endpoint, used to check whether the refresh objects job has finished.
Response Property
Description
status
Status of the job. Can be either completed or processing.

Data Property	Description
A list of destination objects	A list of objects for the given destination. The properties of each destination object are expanded on below in the GET /destinations/[ID] endpoint.

Data Property	Description
label	The label for this object.
full_name	The full name for this object. This is used to identify the object in the API.
supported_operations	A list of the operations this object supports when being synced to.
allow_custom_fields	Whether or not you can define custom fields on this object.
allow_case_sensitive_fields	Whether or not field names and labels are case sensitive on this object.
fields	A list of fields associated with this source. Field properties are described in the table below.

Data Property	Description
label	The label for this field.
full_name	The full name for this field. This is used to identify the field in the API.
createable	Whether or not this field can be created in the destination if it doesn't exist.
updateable	Whether or not this field can be updated in the destination.
operations	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
array	Whether or not this field is an array type.
preserve_values_supported	If a value exists in the destination for this field, whether or not it can be overwritten by Census.
required_for_mapping	Whether or not this field is required.
can_be_upsert_key	Whether or not this field can be the primary identifier for an upsert sync.
can_be_update_key	Whether or not this field can be the primary identifier for an update only sync.
can_be_insert_key	Whether or not this field can be the primary identifier for a create only sync.
can_be_reference_key	Whether or not this field can be the identifier for a lookup on its containing object.
lookup_object	What object, if any, that this field references.
type	The type of this field.

Response Property	Description
refresh_key	Contains an `id` used to query the refresh objects job.

Query Parameter	Description
refresh_key	`required`. An `id` provided by the `refresh_objects` endpoint, used to check whether the refresh objects job has finished.

Response Property	Description
status	Status of the job. Can be either `completed` or `processing`.

Destinations

Sources

Last modified 1mo ago