Skip to Content
DevelopersAPI referenceClients

List clients

GET
/v1/clients

Authorization

apiKey
headerAuthorizationBearer <token>

An API key (blk_…) from Settings → API keys.

Query Parameters

page?integer
Range1 <= value <= 100000
Default1
pageSize?integer
Range1 <= value <= 100
Default25
sort?string
Match^[A-Za-z]+:(asc|desc)$
q?string
Lengthlength <= 100
status?string
Default"active"
Value in"active""archived"

Response Body

application/json
  1. response
items*array<>
total*integer
Range-9007199254740991 <= value <= 9007199254740991
page*integer
Range-9007199254740991 <= value <= 9007199254740991
pageSize*integer
Range-9007199254740991 <= value <= 9007199254740991
Example Request
curl -X GET 'https://your-billleaf-api/v1/clients'
Example Response200
{  "items": [    {      "id": "string",      "workspaceId": "string",      "type": "company",      "name": "string",      "email": "string",      "phone": "string",      "website": "string",      "taxId": "string",      "addressLine1": "string",      "addressLine2": "string",      "city": "string",      "state": "string",      "postalCode": "string",      "country": "string",      "currency": "string",      "paymentTermsDays": -9007199254740991,      "notes": "string",      "status": "active",      "archivedAt": "2019-08-24T14:15:22Z",      "createdAt": "2019-08-24T14:15:22Z",      "updatedAt": "2019-08-24T14:15:22Z"    }  ],  "total": -9007199254740991,  "page": -9007199254740991,  "pageSize": -9007199254740991}