List destination object types

Request schema

Path parameters

destination_id

integerrequired

ID of the destination

Query parameters

page

number

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

default:

per_page

number

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

default:

maximum:

100

order

string

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

default:

desc

enum:

"asc""desc"

Header parameters

Authorization

stringrequired

HTTP: basicAuth

HTTP AuthorizationScheme: basic

Http + 1.1

GET

https://app.getcensus.com/api/v1/destinations/{destination_id}/object_types

GET /api/v1/destinations/{destination_id}/object_types?page=SOME_NUMBER_VALUE&per_page=SOME_NUMBER_VALUE&order=SOME_STRING_VALUE HTTP/1.1
Authorization: Bearer REPLACE_BEARER_TOKEN
Host: app.getcensus.com

Responses

200

Successfully retrieved the list of destination object types.

404

Resource not found.

`200`

status

stringrequired

The outcome of the request

enum:

"success"

pagination

objectrequired

An object to help you navigate the list of results.

total_records

number

Total records in the collection.

example:

per_page

number

Records on each page.

default:

example:

prev_page

number | null

The previous page number, or null for the first page.

example:

page

number

The current page number.

default:

example:

next_page

number | null

The next page number, or null if it's the last page.

example:

last_page

number

The number of the last page with records.

example:

data

arrayrequired

The list of results.

type

string

The type of destination object.

example:

Sheet

object_attributes

array

A list of attributes associated with this object type.

key

string

The key for this object attribute.

example:

sheetName

label

string

The label for this object attribute.

example:

Sheet Name

type

string

The type of data this object contains.

enum:

"string""number""boolean""integer"

required

boolean

Whether or not this object attribute is required.

example:

true

hint

string

A hint for this object attribute.

example:

Either spreadsheetName or spreadsheetId is required.

possible_values

array

Possible enumerated values for this attribute. May only appear if the attribute's type is a string

type:

string

field_attributes

array

A list of fields attributes associated with this object type.

key

string

The key for this object attribute.

example:

sheetName

label

string

The label for this object attribute.

example:

Sheet Name

type

string

The type of data this object contains.

enum:

"string""number""boolean""integer"

required

boolean

Whether or not this object attribute is required.

example:

true

hint

string

A hint for this object attribute.

example:

Either spreadsheetName or spreadsheetId is required.

possible_values

array

Possible enumerated values for this attribute. May only appear if the attribute's type is a string

type:

string

`404`

status

integer

HTTP status code.

enum:

"404"

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