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
- VAT codes
- Attachments
Invoicing
- Contacts
- Invoices
- Products
- Taxes
- Opportunities
- Payments
- Payment methods
POS
- Orders
- Payment methods
- Payments
- Closure info
- Locations
- Products
- Categories
- Customers
- Objectives
eCommerce
- Orders
- Products & variants
- Categories
- Customers
- Payment methods
- Locations
- Countries
- Taxes
PMS
- Orders
- Invoices
- Payment methods
- Payments
- Closure info
- Locations
- Categories
- Customers
- Taxes
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": "John",
"last_name": "Doe",
"company_name": "Acme Corp",
"phone": "+1234567890",
"email": "john.doe@example.com",
"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
}
Authorizations
This access token needs to be included in each of your request to the Chift API.
Path Parameters
Query Parameters
Page number
Required range:
x >= 1
Page size
Required range:
1 <= x <= 100
Response
200
application/json
Successful Response
The response is of type object
.
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": "john.doe@example.com",
"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
}
Assistant
Responses are generated using AI and may contain mistakes.