Skip to main content
GET
Get a client

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 public 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 | null

Email address

phone
string | null

Phone number

website
string | null

Website URL

stageId
string | null

Client stage public ID

customFields
object | null

Custom field values