curl --request GET \
--url https://{your-subdomain}.neetoinvoice.com/api/external/v2/clients \
--header 'X-Api-Key: <x-api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>'}};
fetch('https://{your-subdomain}.neetoinvoice.com/api/external/v2/clients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{your-subdomain}.neetoinvoice.com/api/external/v2/clients"
headers = {"X-Api-Key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"total_count": 1,
"page": 1,
"page_size": 30,
"total_pages": 1,
"next_page": null,
"prev_page": null,
"clients": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"identifier": "a8b90a464cad12b48e45",
"name": "<string>",
"secondary_name": "<string>",
"status": "active",
"currency": "USD",
"default_invoice_due_in_days": 30
}
]
}List clients
List the workspace’s clients ordered by name. Without page or page_size, the response holds every record on one page. When you send either one, the list is paginated: 30 per page by default and up to 100.
curl --request GET \
--url https://{your-subdomain}.neetoinvoice.com/api/external/v2/clients \
--header 'X-Api-Key: <x-api-key>'const options = {method: 'GET', headers: {'X-Api-Key': '<x-api-key>'}};
fetch('https://{your-subdomain}.neetoinvoice.com/api/external/v2/clients', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{your-subdomain}.neetoinvoice.com/api/external/v2/clients"
headers = {"X-Api-Key": "<x-api-key>"}
response = requests.get(url, headers=headers)
print(response.text){
"total_count": 1,
"page": 1,
"page_size": 30,
"total_pages": 1,
"next_page": null,
"prev_page": null,
"clients": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"identifier": "a8b90a464cad12b48e45",
"name": "<string>",
"secondary_name": "<string>",
"status": "active",
"currency": "USD",
"default_invoice_due_in_days": 30
}
]
}{your-subdomain} with your workspace’s subdomain. Learn how to find your subdomain in Workspace subdomain.
Headers
Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.
Query Parameters
Only clients with this status.
active, archived Only clients whose name contains this text. The match is case-insensitive.
Page of results to retrieve, starting from 1. Defaults to 1 when omitted.
Number of results per page. Defaults to 30 when omitted.
1 <= x <= 100Response
OK - Request succeeded
Total number of records across all pages.
1
Current page number.
1
Number of records per page.
30
Total number of pages.
1
Next page number, or null on the last page.
null
Previous page number, or null on the first page.
null
Hide child attributes
Hide child attributes