v1
latestOpenAPI 3.1.02026-08-0658107212.4 KBClients
List All Clients
Returns a list of all your clients.
get/clients.json
Query parameters
api_keystring required
Example:YOUR_API_KEY
Your API Key.
pageinteger
Example:1
You can ask for a specific page of results. Defaults to 1.
per_pageinteger
Example:30
You can specify how many results you want to fetch. Defaults to 10 or value defined in account settings (10, 20 or 30).
Response
SUCCESS
Example response
{
"clients": [
{
"name": "Client Name",
"code": "12345",
"email": "foo@bar.com",
"language": "pt",
"address": "Avenida da República, Lisboa",
"city": "Lisboa",
"postal_code": "1050-555",
"country": "Portugal",
"fiscal_id": "508025338",
"website": "www.invoicexpress.com",
"phone": "213456789",
"fax": "213456788",
"preferred_contact": {
"name": "Bruce Norris",
"email": "email@invoicexpress.com",
"phone": "213456789"
},
"observations": "Observations",
"send_options": "1"
}
],
"pagination": {
"total_entries": 6,
"current_page": 1,
"total_pages": 1,
"per_page": 10
}
}