---
title: "The objects a preview would create"
method: GET
path: "/consumers/{consumer_id}/syncs/{syncid}/previews/{preview_id}/objects"
tags: ["Syncs"]
---

# The objects a preview would create

`GET /consumers/{consumer_id}/syncs/{syncid}/previews/{preview_id}/objects`

## Request

- Base URL: `https://api.chift.eu`
- URL: `https://api.chift.eu/consumers/{consumer_id}/syncs/{syncid}/previews/{preview_id}/objects`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/chift/apis/chift-api/docs/consumers/:consumer_id/syncs/:syncid/previews/:preview_id/objects/get.ts> (a function with typed inputs; its response is checked against the schema)

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

## Path parameters

- `consumer_id` string, uuid, required
- `syncid` string, uuid, required
- `preview_id` string, uuid, required

## Query parameters

- `kind` string, nullable: Only the objects of this kind, e.g. 'invoice'.
- `capability` string, nullable: Only the objects of this capability (its key).
- `page` integer
- `size` integer
- `language` string, 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 `200`

Successful Response

- ChiftPagePreviewObjectItem
  - `items` PreviewObjectItem[], required
    - `synthetic_id` string, required: The object's id in the preview: the same data gets the same id in every preview.
    - `kind` string, required: What would be created.
    - `kind_title` string, required: Name to show, in the requested language; its translation key without one.
    - `capability` string, required: Key of the capability creating it.
    - `capability_title` string, required: Name to show, in the requested language; its translation key without one.
    - `source_id` string, nullable, required: The source object it is created for.
    - `summary` PreviewSummary, required
      - `title` string, nullable: Its name or number.
      - `amount` number, nullable: Its total or amount.
      - `currency` string, nullable: The amount's currency.
      - `date` string, date, nullable: Its date.
    - `links` PreviewLink[], required: The objects it needs, e.g. an invoice's supplier.
      - `relation` string, required: How the objects relate.
      - `synthetic_id` string, required: The other object's id in the preview.
      - `title` string, nullable: The other object's summary title, else its source id.
    - `payload` object, required: What would be sent to the target, as its create route takes it, but each partner it books on by its name (an invoice's partner, an entry line's partner account).
  - `total` integer, required
  - `page` integer, required
  - `size` integer, required

## Other responses

- `404`: Not Found
- `422`: Validation Error

## Changes

- **2026-11-03** `020884969534`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/chift/apis/chift-api/changes/consumers/:consumer_id/syncs/:syncid/previews/:preview_id/objects/get.md)

---

[API](https://skmtc.dev/chift/apis/chift-api.md) - [All operations](https://skmtc.dev/chift/apis/chift-api/llms.txt) - [OpenAPI document](https://skmtc.dev/chift/apis/chift-api/revisions/020884969534?raw)