Skip to main content
GET
/
consumers
/
{consumer_id}
/
invoicing
/
contacts
Retrieve all contacts
curl --request GET \
  --url https://api.chift.eu/consumers/{consumer_id}/invoicing/contacts \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "<string>",
      "source_ref": {
        "id": "<string>",
        "model": "<string>"
      },
      "is_prospect": true,
      "is_customer": true,
      "is_supplier": true,
      "is_company": true,
      "company_name": "<string>",
      "first_name": "<string>",
      "last_name": "<string>",
      "email": "<string>",
      "phone": "<string>",
      "mobile": "<string>",
      "company_id": "<string>",
      "vat": "<string>",
      "company_number": "<string>",
      "currency": "<string>",
      "language": "<string>",
      "comment": "<string>",
      "customer_account_number": "<string>",
      "supplier_account_number": "<string>",
      "birthdate": "2023-12-25",
      "gender": "H",
      "addresses": [],
      "external_reference": "<string>"
    }
  ],
  "total": 1,
  "page": 2,
  "size": 2
}

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

Query Parameters

​
page
integer
default:1

Page number

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

Page size

Required range: 1 <= x <= 100
​
contact_type
enum<string>
default:all
Available options:
prospect,
customer,
supplier,
all

Response

Successful Response

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