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
List destinations
curl --request GET \
--url https://app.getcensus.com/api/v1/destinations \
--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": [
{
"id": 12,
"name": "Google Sheets",
"created_at": "2023-07-22T23:42:47.239Z",
"last_test_results": {
"steps": [
{
"step": "Verify connectivity",
"error": {
"message": "<string>"
},
"status": "success"
}
]
},
"last_test_succeeded": true,
"last_tested_at": "2023-11-07T05:31:56Z",
"connection_details": {
"account_id": "7515011393,",
"account_name": "Manager Account Test"
},
"objects": [
{
"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.
Query Parameters
Designates which page of results to return. Always starts at 1. If 0 is specified, it defaults to 1.
Determines the number of results on each page. It can't exceed 100.
x <= 100Organizes the results based on their creation time, either ascending or descending.
asc, desc Response
A successfully fetched list of results.
The outcome of the request
success "success"
An object to help you navigate the list of results.
Total records in the collection.
14
Records on each page.
25
The previous page number, or null for the first page.
1
The current page number.
2
The next page number, or null if it's the last page.
3
The number of the last page with records.
10
The list of results.
The id of this destination.
12
The name of this destination.
"Google Sheets"
When the connection was created
"2023-07-22T23:42:47.239Z"
An ordered array of steps representing the results of the last connection test. If one step fails then we won't surface details on later steps.
The name of the step in the connection test process.
"Verify connectivity"
The status of the step.
running, success, failed, warning "success"
Indicates if the last connection test to this destination was successful.
true
Timestamp of when the last connection test was conducted on this destination.
Connection details associated with this destination.
{
"account_id": "7515011393,",
"account_name": "Manager Account Test"
}
A list of objects associated with this destination.
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 \
--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": [
{
"id": 12,
"name": "Google Sheets",
"created_at": "2023-07-22T23:42:47.239Z",
"last_test_results": {
"steps": [
{
"step": "Verify connectivity",
"error": {
"message": "<string>"
},
"status": "success"
}
]
},
"last_test_succeeded": true,
"last_tested_at": "2023-11-07T05:31:56Z",
"connection_details": {
"account_id": "7515011393,",
"account_name": "Manager Account Test"
},
"objects": [
{
"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"
}
]
}
]
}
]
}