GET
/
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,
          "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
headerrequired

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

Query Parameters

page
number
default: 1

Designates which page of results to return. Always starts at 1. If 0 is specified, it defaults to 1.

per_page
number
default: 25

Determines the number of results on each page. It can't exceed 100.

order
enum<string>
default: desc

Organizes the results based on their creation time, either ascending or descending.

Available options:
asc,
desc

Response

200 - application/json
status
enum<string>
required

The outcome of the request

Available options:
success
pagination
object
required

An object to help you navigate the list of results.

data
object[]
required

The list of results.