Skip to main content
GET
Get Sync Draft

Authorizations

Authorization
string
header
required

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

Path Parameters

syncId
number<double>
required

The id of the sync

draftId
string
required

The id of the draft

Response

Ok

id
string
required

The draft's id

syncId
string
required

The id of the sync the draft changes

operation
enum<string>
required

create publishes a new sync, update changes an existing one

Available options:
create,
update
status
enum<string>
required

The state of a sync draft. New values may be added, so treat an unknown value as closed.

Available options:
pending,
approved,
rejected,
canceled
requestedBy
object | null
required

The user who submitted the draft

requestedApprovers
object[]
required

The users asked to review the draft

requestComment
string | null
required

The comment the requester left for reviewers

createdAt
string<date-time>
required

The timestamp when the draft was created

updatedAt
string<date-time>
required

The timestamp when the draft last changed

reviewedBy
object | null
required

The user who approved or rejected the draft. With an API key, this is the user who owns the key.

reviewedAt
string<date-time> | null
required

The timestamp when the draft was approved or rejected

reviewMetadata
object | null
required

The metadata sent with the approval or rejection

current
object | null
required

The sync as it is now, or null for a draft that creates the sync

proposed
object | null
required

The sync as it will be after approval, or null once the draft is closed

changedFields
string[]
required

The top-level sync fields that the draft changes

draftVersion
string
required

Send as expectedDraftVersion to approve exactly this version of the draft

resourceVersion
string
required

Send as expectedResourceVersion to approve only if the sync has not changed