Customers
Get customers (PMS)
API Reference Overview
Authentication
Consumers
Connections
Accounting
- Folders
- Book years
- Clients
- Suppliers
- Invoices
- Ledger accounts
- Journals
- Journal entries
- Employees
- Analytic plans
- Analytic accounts
- Miscellaneous operations
- Outstandings
Invoicing
- Contacts
- Invoices
- Products
- Taxes
- Opportunities
- Payments
- Payment methods
POS
- Orders
- Payment methods
- Payments
- Closure info
- Locations
- Products
- Categories
- Customers
eCommerce
- Orders
- Products & variants
- Categories
- Customers
- Payment methods
- Locations
- Countries
- Taxes
PMS
- Orders
- Invoices
- Payment methods
- Payments
- Closure info
- Locations
- Categories
- Customers
Payment
- Payments
- Balances
- Transactions
- Refunds
Banking
- Financial institutions
- Banking accounts
- Transactions
Advanced
- Webhooks
- Syncs
- Issues
- Datastores
Customers
Get customers (PMS)
Returns a list of all the customers
GET
/
consumers
/
{consumer_id}
/
pms
/
customers
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": "<string>",
"last_name": "<string>",
"company_name": "<string>",
"phone": "<string>",
"email": "<string>",
"account_number": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"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
}
Authorizations
This access token needs to be included in each of your request to the Chift API.
Path Parameters
Query Parameters
Required range:
x >= 1
Required range:
1 <= x <= 100
Response
200
application/json
Successful Response
Technical id in Chift
First name of the customer. In case the customer is an individual.
Last name of the customer. In case the customer is an individual.
Company name of the customer. In case the customer is a company.
Phone number of the customer
Email address of the customer
Number of the accounting account used (e.g. 701000)
Creation date of the customer
List of addresses related to the customer
Type of the address
Example:
"home"
Name given to the address (e.g. 'home')
Example:
"Home"
Street name
Example:
"Main Street"
Number of the address
Example:
"123"
Box of the address
Example:
"A"
City name
Example:
"Paris"
Postal code of the address
Example:
"75000"
Country, format: ISO 3166-1 codes.
Example:
"FR"
Required range:
x >= 0
Required range:
x >= 1
Required range:
x >= 1
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": "<string>",
"last_name": "<string>",
"company_name": "<string>",
"phone": "<string>",
"email": "<string>",
"account_number": "<string>",
"created_on": "2023-11-07T05:31:56Z",
"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
}