Clients

Get a client

Returns a single client by its public ID.

get/clients/{id}

Request

  • Base URL: https://api.heffl.com/api/v1
  • URL: https://api.heffl.com/api/v1/clients/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Client public ID

Response

OK

idstring required

Client public ID

numberstring required

Auto-generated client number

namestring required

Client name

type'company' | 'contact' required

Client type

firstNamestring nullable

First name (for contacts)

lastNamestring nullable

Last name (for contacts)

emailstring nullable

Email address

phonestring nullable

Phone number

websitestring nullable

Website URL

stageIdstring nullable

Client stage public ID

createdAtstring date-time required

When the client was created

customFieldsobject nullable

Custom field values

Changes

No recorded changes to this operation across all 1 revision of this API.