Skip to content

Get Object Sync Setup Defaults

GET
/integrations/object-sync/setup-defaults

The setup step’s prefill for one CRM object, including the suggested match key. Owner or Admin.

Authorizations

Parameters

Query Parameters

connection_id
required

The CRM connection id.

string
>= 1 characters <= 255 characters

The CRM connection id.

crm_object_id
required

The CRM object id, e.g. Contact or 2-123456.

string
>= 1 characters <= 255 characters

The CRM object id, e.g. Contact or 2-123456.

object_definition_id
Any of:
string format: uuid

The graph8 custom object, when chosen.

Header Parameters

X-Target-Org-Id
Any of:
string

Responses

200

Successful Response

object
data
required

An object-sync answer: capability, setup defaults, a binding, a run, a conflict list or a resolution.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string