Skip to main content
GET
/
clients
/
{id}
Get a client
curl --request GET \
  --url https://api.heffl.com/api/v1/clients/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "number": "<string>",
  "name": "<string>",
  "type": "company",
  "createdAt": "2023-11-07T05:31:56Z",
  "firstName": "<string>",
  "lastName": "<string>",
  "email": "[email protected]",
  "phone": "<string>",
  "website": "<string>"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Path Parameters

​
id
string
required

Client public ID

Response

200 - application/json

OK

​
id
string
required

Client ID

​
number
string
required

Auto-generated client number

​
name
string
required

Client name

​
type
enum<string>
required

Client type

Available options:
company,
contact
​
createdAt
string<date-time>
required

When the client was created

​
firstName
string | null

First name (for contacts)

​
lastName
string | null

Last name (for contacts)

​
email
string<email> | null

Email address

​
phone
string | null

Phone number

​
website
string | null

Website URL