Skip to main content
GET
What a consumer's sync did to one object

Authorizations

Authorization
string
header
required

This access token needs to be included in each of your request to the Chift API.

Path Parameters

consumer_id
string<uuid>
required
syncid
string<uuid>
required
kind
string
required
object_id
string<uuid>
required

Query Parameters

language
string | null

ISO 639-1 code of the language of the texts (en, fr, nl, de, es; any case), falling back to English. Without it, translation keys.

Response

Successful Response

id
string<uuid>
required

The object's id: read it with GET …/objects/{kind}/{id}.

kind
string
required

The object's type, e.g. 'supplier_invoice'.

capability
string
required

Key of the capability that handles it.

source_id
string
required

Its id in the source.

scope
Scope · object
required

What identifies it beside its source id, for a sync keying its objects on something the consumer runs several of: {"location_id": "paris"}. Empty otherwise.

status
string
required

Where it stands, e.g. 'pending', 'success', 'failed', 'skipped', 'never_retry'.

target_id
string | null
required

What it was booked as in the target. Null until then.

booked_as
string | null
required

Key of the mode that booked it.

attempts
integer
required

How many times it failed.

last_error_code
string | null
required

The code of its last failure.

created_at
string<date-time>
required

When the sync first saw it.

updated_at
string<date-time>
required

When it last changed.

succeeded_at
string<date-time> | null
required

When it was booked.

target
Target · object | null
required

What it was booked as, as the target answered.

history
ObjectEventItem · object[]
required

What happened to it, the oldest first.

The objects it needed, and those that needed it.

issues
SyncIssue · object[]
required

The open issues holding it up.