GET
/
destinations
/
{destination_id}
/
object_types
curl --request GET \
  --url https://app.getcensus.com/api/v1/destinations/{destination_id}/object_types \
  --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": [
    {
      "type": "Sheet",
      "object_attributes": [
        {
          "key": "sheetName",
          "label": "Sheet Name",
          "type": "string",
          "required": true,
          "hint": "Either spreadsheetName or spreadsheetId is required.",
          "possible_values": [
            "<string>"
          ]
        }
      ],
      "field_attributes": [
        {
          "key": "sheetName",
          "label": "Sheet Name",
          "type": "string",
          "required": true,
          "hint": "Either spreadsheetName or spreadsheetId is required.",
          "possible_values": [
            "<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

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.

Required range: x <= 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
Successfully retrieved the list of destination object types.

A successfully fetched list of results.

​
status
enum<string>
required

The outcome of the request

Available options:
success
Example:

"success"

​
pagination
object
required

An object to help you navigate the list of results.

​
data
object[]
required

The list of results.

Was this page helpful?

Raise issue
Fetch destination objectStart fields refresh