Fetch destination
Request schema
Path parameters
ID of the destination to retrieve
Header parameters
HTTP: basicAuth
HTTP AuthorizationScheme: basic
GET /api/v1/destinations/{destination_id} HTTP/1.1 Authorization: Bearer REPLACE_BEARER_TOKEN Host: app.getcensus.com
Responses
200
Outcome of the operation.
The id of this destination.
The name of this destination.
When the connection was created
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.
The error message associated with the step, if any.
The status of the step.
Indicates if the last connection test to this destination was successful.
Timestamp of when the last connection test was conducted on this destination.
Connection details associated with this destination.
additional property
Whether this destination is a file system destination (e.g., S3, SFTP, Google Cloud Storage). When true, please provide the file path as the object full name for sync creation. See an example of an API request to create a sync to a file system destination here.
A list of objects associated with this destination.
The label for this object.
The full name for this object. This is used to identify the object in the API.
A list of the operations this object supports when being synced to.
Information on the primary identifier mapping requirements between the source and destination, per supported operation. The keys in this object correspond to the supported operations for this destination object.
additional property
Whether a primary identifier mapping must be provided for this operation.
Whether the destination key selector can be hidden in the UI for this operation. When true, the primary identifier mapping destination field can be hardcoded to the only available primary identifier field for the object. This is most commonly true for the append operation, when Census only needs to know the source column to use to identify new records.
Additional notes or instructions for this operation's configuration.
Whether or not you can define custom fields on this object.
A list of field types that can be used when creating custom fields on this destination object. Only present when allow_custom_fields is true. Each entry includes the type and whether it is an array type.
The data type of the custom field. This value should be used when defining the field_type for a custom field in the create sync payload. A type of Field is a generic type representing a field type of any.
Whether this is an array type. This value should be used when defining the array_field attribute for a custom field in the create sync payload.
Whether or not field names and labels are case sensitive on this 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.
The unique identifier for this field.
The data type of this field.
The human-readable label for this field.
The type of input control to use for this field.
The order in which this field should be displayed.
Placeholder text for the input field.
The default value for this field. Type varies based on the field type.
Whether this field is required to be provided.
Valid values for this field (typically used with dropdown input_type). Array items can be strings, integers, or other types.
Whether this field cannot be changed after the initial creation.
Conditional logic for when to show this field based on other field values.
URL to documentation providing more information about this field.
Operations where this field is applicable (e.g., merge, overwrite).
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.
Whether or not you can create a sync to this object. This will be false if the object has been deleted.
A list of fields associated with this destination.
The label for this field.
The full name for this field. This is used to identify the field in the API.
Whether or not this field can be created in the destination if it doesn't exist.
Whether or not this field can be updated in the destination.
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
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.
Whether or not this field is required.
Whether or not this field can be the primary identifier for an upsert sync.
Whether or not this field can be the primary identifier for an update only sync.
Whether or not this field can be the primary identifier for a create only sync.
Whether or not this field can be the identifier for a lookup on its containing object.
What object, if any, that this field references.
The type of this field.
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.
additional property
{ "status": "created", "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": "2019-08-24T14:15:22Z", "connection_details": { "account_id": "7515011393,", "account_name": "Manager Account Test" }, "is_file_system_destination": false, "objects": [ { "label": "User", "full_name": "user", "supported_operations": [ "insert", "update", "upsert" ], "primary_identifier_mapping_attributes": { "upsert": { "required": true, "hide_destination_key": false, "notes": "Your identifier must be a valid email." }, "mirror": { "required": false, "hide_destination_key": false, "notes": null } }, "allow_custom_fields": true, "supported_custom_field_types": [ { "type": "String", "array": false } ], "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, "is_audience_destination": false, "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" } } ] } }