Introduction
Organization APIs
- Users
- Invitations
- Workspaces
Workspace APIs
- Syncs
- Sync Management Links
- Sync Runs
- Destination Types
- Destinations
- Destination Connect Links
- Source Types
- Sources
- Source Connect Links
- Segment Management Links
Fetch destination object
This endpoint lists information for a given object, including information on what fields it includes.
curl --request GET \
--url https://app.getcensus.com/api/v1/destinations/{destination_id}/objects/{object_full_name} \
--header 'Authorization: Bearer <token>'{
"status": "success",
"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
Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.
Path Parameters
ID of the destination that owns the object
full_name of the destination object
Response
Outcome of the operation.
success, updated, created, not_found, error "success"
The label for this object.
"User"
The full name for this object. This is used to identify the object in the API.
"user"
A list of the operations this object supports when being synced to.
append, insert, mirror, update, upsert ["insert", "update", "upsert"]
Whether or not you can define custom fields on this object.
true
Whether or not field names and labels are case sensitive on this object.
true
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.
false
Whether or not you can create a sync to this object. This will be false if the object has been deleted.
true
A list of fields associated with this destination.
A field available on a destination object that can be mapped to.
The label for this field.
"External User ID"
The full name for this field. This is used to identify the field in the API.
"external_id"
Whether or not this field can be created in the destination if it doesn't exist.
true
Whether or not this field can be updated in the destination.
true
For an array type, what operations are supported on this field. One of the following types:
overwrite: Overwrite existing values with inputted valuesmerge: Merge inputted values with existing values
overwrite, merge Whether or not this field is an array type.
If a value exists in the destination for this field, whether or not it can be overwritten by Census.
true
Whether or not this field is required.
true
Whether or not this field can be the primary identifier for an upsert sync.
true
Whether or not this field can be the primary identifier for an update only sync.
true
Whether or not this field can be the primary identifier for a create only sync.
true
Whether or not this field can be the identifier for a lookup on its containing object.
true
What object, if any, that this field references.
"company"
The type of this field.
"string"
Was this page helpful?
curl --request GET \
--url https://app.getcensus.com/api/v1/destinations/{destination_id}/objects/{object_full_name} \
--header 'Authorization: Bearer <token>'{
"status": "success",
"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"
}
]
}
}