Skip to Content
DevelopersAPI referenceClients

Get client

GET
/v1/clients/{id}

Authorization

apiKey
headerAuthorizationBearer <token>

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

Path Parameters

id*string

Response Body

application/json
  1. response
id*string
workspaceId*string
type*string
Value in"company""individual"
name*string
email*string|null
phone*string|null
website*string|null
taxId*string|null
addressLine1*string|null
addressLine2*string|null
city*string|null
state*string|null
postalCode*string|null
country*string|null
currency*string|null
paymentTermsDays*|
Range-9007199254740991 <= value <= 9007199254740991
notes*string|null
status*string
Value in"active""archived"
archivedAt*|
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time
createdAt*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time
updatedAt*string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time
contacts*array<>
Example Request
curl -X GET 'https://your-billleaf-api/v1/clients/string'
Example Response200
{  "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",  "contacts": [    {      "id": "string",      "clientId": "string",      "name": "string",      "email": "string",      "phone": "string",      "title": "string",      "isPrimary": true,      "createdAt": "2019-08-24T14:15:22Z"    }  ]}