cURL
curl --request GET \ --url https://api.chift.eu/consumers/{consumer_id}/pms/customers \ --header 'Authorization: Bearer <token>'
{ "items": [ { "id": "<string>", "source_ref": { "id": "<string>", "model": "<string>" }, "first_name": "John", "last_name": "Doe", "company_name": "Acme Corp", "phone": "+1234567890", "email": "[email protected]", "account_number": "701000", "created_on": "2023-09-25T12:00:00", "addresses": [ { "address_type": "home", "name": "Home", "street": "Main Street", "number": "123", "box": "A", "city": "Paris", "postal_code": "75000", "country": "FR" } ] } ], "total": 1, "page": 2, "size": 2 }
Returns a list of all the customers
This access token needs to be included in each of your request to the Chift API.
Page number Page number
x >= 1
Page size Page size
1 <= x <= 100
Successful Response
Show child attributes
Technical id in Chift
Technical id in the target software
Name of the model/entity in the target software
First name of the customer. In case the customer is an individual.
"John"
Last name of the customer. In case the customer is an individual.
"Doe"
Company name of the customer. In case the customer is a company.
"Acme Corp"
Phone number of the customer
"+1234567890"
Email address of the customer
"[email protected]"
Number of the accounting account used (e.g. 701000)
"701000"
Creation date of the customer
"2023-09-25T12:00:00"
List of addresses related to the customer
Type of the address
"home"
Name given to the address (e.g. 'home')
"Home"
Street name
"Main Street"
Number of the address
"123"
Box of the address
"A"
City name
"Paris"
Postal code of the address
"75000"
Country, format: ISO 3166-1 codes.
"FR"
x >= 0