GET
/
destinations
/
{destination_id}
/
objects
curl --request GET \
  --url https://app.getcensus.com/api/v1/destinations/{destination_id}/objects \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "allow_case_sensitive_fields": true,
      "allow_custom_fields": true,
      "fields": [
        {
          "array": true,
          "can_be_insert_key": true,
          "can_be_reference_key": true,
          "can_be_update_key": true,
          "can_be_upsert_key": true,
          "createable": true,
          "full_name": "external_id",
          "label": "External User ID",
          "lookup_object": "company",
          "operations": [
            "overwrite"
          ],
          "preserve_values_supported": true,
          "required_for_mapping": true,
          "type": "string",
          "updateable": true
        }
      ],
      "full_name": "user",
      "label": "User",
      "supported_operations": [
        "insert",
        "update",
        "upsert"
      ]
    }
  ],
  "pagination": {
    "last_page": 10,
    "next_page": 3,
    "page": 2,
    "per_page": 25,
    "prev_page": 1,
    "total_records": 14
  },
  "status": "success"
}

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

destination_id
integer
required

ID of the destination

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
data
object[]
required

The list of results.

pagination
object
required

An object to help you navigate the list of results.

status
enum<string>
required

The outcome of the request

Available options:
success