Skip to main content
GET
The objects a preview would create

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
preview_id
string<uuid>
required

Query Parameters

kind
string | null

Only the objects of this kind, e.g. 'invoice'.

capability
string | null

Only the objects of this capability (its key).

page
integer
default:1
Required range: x >= 1
size
integer
default:50
Required range: 1 <= x <= 500
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

items
PreviewObjectItem · object[]
required
total
integer
required
Required range: x >= 0
page
integer
required
Required range: x >= 1
size
integer
required
Required range: x >= 1