Fetch destination object

Authorizations

Authorization

string

headerrequired

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 that owns the object

object_full_name

string

required

full_name of the destination object

Response

200 - application/json

status

enum<string>

Outcome of the operation.

Available options:

success,

updated,

created,

not_found,

error

data

object

data.label

string

The label for this object.

data.full_name

string

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

data.supported_operations

enum<string>[]

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

Available options:

append,

insert,

mirror,

update,

upsert

data.allow_custom_fields

boolean

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

data.allow_case_sensitive_fields

boolean

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

data.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.

data.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.

data.fields

object[]

A list of fields associated with this destination.

Introduction

Organization APIs

Workspace APIs

Authorizations

Path Parameters

Response