Retrieve a list of all customers.
Parameters
Header
Authorization*
string
API key as bearer token
Accept*
string
application/json
Query
start*
Date
Start of the search
end*
Date
End of the search
Request Example
Responses
List of customers received successfully
Authorization information missing, expired or invalid
GET/api/v1/customers/{id}
Retrieve a specific customer by ID.
Parameters
Header
Authorization*
string
API key as bearer token
Accept*
string
application/json
Path
id*
string
ID of the customer to get
Request Example
Responses
Customer received successfully
Authorization information missing, expired or invalid
PATCH/api/v1/customers/{id}
Update a specific customer by ID.
Parameters
Header
Authorization*
string
API key as bearer token
Accept*
string
application/json
Content-Type*
string
application/json
Path
id*
string
ID of the customer to update
Body
name
string
Name of the customer
email
string
Email of the customer
phoneNumber
string | null
Phone number of the customer
address
string | null
Address of the customer
tags
string[]
Tags for the customer
Request Example
Responses
Customer updated successfully
Authorization information missing, expired or invalid
DELETE/api/v1/customers/{id}
Delete a specific customer by ID.
Parameters
Header
Authorization*
string
API key as bearer token
Accept*
string
application/json
Path
id*
string
ID of the customer to delete
Request Example
Responses
Customer deleted successfully
Authorization information missing, expired or invalid