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,
"advanced_configuration_field_definitions": [
{
"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"
]
}
],
"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"
}
],
"configurable_field_definitions": {
"http_endpoint": "string",
"batch_size": "integer"
}
}
}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,
"advanced_configuration_field_definitions": [
{
"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"
]
}
],
"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"
}
],
"configurable_field_definitions": {
"http_endpoint": "string",
"batch_size": "integer"
}
}
}Was this page helpful?