Fetch destination

GET

destinations

{destination_id}

curl --request GET \
  --url https://app.getcensus.com/api/v1/destinations/{destination_id} \
  --header 'Authorization: Bearer <token>'

{
  "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": "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

Authorization

string

header

required

Bearer token for the current workspace. Can be retrieved from the Workspace's settings page.

Path Parameters

destination_id

integer

required

ID of the destination to retrieve

Response

200 - application/json

Successfully retrieved the destination

status

enum<string>

Outcome of the operation.

Available options:

success,

updated,

created,

not_found,

error

Example:

"created"

data

object

data.id

integer

The id of this destination.

Example:

12

data.name

string

The name of this destination.

Example:

"Google Sheets"

data.created_at

string

When the connection was created

Example:

"2023-07-22T23:42:47.239Z"

data.last_test_results

object

data.last_test_succeeded

boolean | null

Indicates if the last connection test to this destination was successful.

Example:

true

data.last_tested_at

string | null

Timestamp of when the last connection test was conducted on this destination.

data.connection_details

object

Connection details associated with this destination.

Example:

{
  "account_id": "7515011393,",
  "account_name": "Manager Account Test"
}

data.objects

object[]

A list of objects associated with this destination.

data.objects.label

string

The label for this object.

Example:

"User"

data.objects.full_name

string

The full name for this object. This is used to identify the object in the API.

Example:

"user"

data.objects.supported_operations

enum<string>[]

A list of the operations this object supports when being synced to.

Available options:

append,

insert,

mirror,

update,

upsert

Example:

["insert", "update", "upsert"]

data.objects.allow_custom_fields

boolean

Whether or not you can define custom fields on this object.

Example:

true

data.objects.allow_case_sensitive_fields

boolean

Whether or not field names and labels are case sensitive on this object.

Example:

true

data.objects.supports_field_ordering

boolean

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.

Example:

false

data.objects.can_be_sync_destination

boolean

Whether or not you can create a sync to this object. This will be false if the object has been deleted.

Example:

true

data.objects.fields

object[]

A list of fields associated with this destination.

A field available on a destination object that can be mapped to.

Was this page helpful?

Raise issue

Create a new destination Update destination

curl --request GET \
  --url https://app.getcensus.com/api/v1/destinations/{destination_id} \
  --header 'Authorization: Bearer <token>'

{
  "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": "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"
          }
        ]
      }
    ]
  }
}

Introduction

Organization APIs

Workspace APIs

Authorizations

Path Parameters

Response