Skip to main content
GET
/
consumers
/
{consumer_id}
/
accounting
/
clients
Get clients
curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/accounting/clients
{
  "items": [
    {
      "external_reference": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "name": "<string>",
      "function": "<string>",
      "is_company": true,
      "company_id": "<string>",
      "phone": "<string>",
      "mobile": "<string>",
      "email": "<string>",
      "language": "<string>",
      "internal_notes": "<string>",
      "website": "<string>",
      "vat": "<string>",
      "iban": "<string>",
      "bank_account": "<string>",
      "currency": "<string>",
      "active": true,
      "account_number": "<string>",
      "company_number": "<string>",
      "id": "<string>",
      "last_updated_on": "2023-11-07T05:31:56Z",
      "addresses": [],
      "third_party_account": "<string>"
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2
}

Documentation Index

Fetch the complete documentation index at: https://docs.chift.eu/llms.txt

Use this file to discover all available pages before exploring further.

Path Parameters

​
consumer_id
string<uuid>
required

Query Parameters

​
page
integer
default:1

Page number

Required range: x >= 1
​
size
integer
default:50

Page size

Required range: 1 <= x <= 100
​
folder_id
string | null

Id of the accounting folder instance. A folder represents a legal entity within the system. Required when the multiple folders feature is enabled.

​
search
string | null

Filter based on the following fields: name, email, first_name, last_name, external_reference, vat and company_number

​
updated_after
string<date-time> | null

Retrieve clients created or updated after a specific datetime (e.g. 2023-01-31T15:00:00 for 31 of January 2023 at 3PM UTC). UTC is the only format that is supported on all connectors.

Response

Successful Response

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