CHchift
Syncs

The objects a preview would create

Changed on

One page of them, in the order they would be created, filtered by kind or capability.

get/consumers/{consumer_id}/syncs/{syncid}/previews/{preview_id}/objects

Request

Path parameters

consumer_idstring uuid required
syncidstring uuid required
preview_idstring uuid required

Query parameters

kindstring nullable

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

capabilitystring nullable

Only the objects of this capability (its key).

pageinteger
sizeinteger
languagestring nullable

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

totalinteger required
pageinteger required
sizeinteger required

Example response

{
  "items": [
    {
      "synthetic_id": "preview:invoice:3f2a9c1e0b4d",
      "kind": "invoice",
      "kind_title": "Invoice",
      "links": [
        {
          "relation": "needs"
        }
      ]
    }
  ]
}

Changes