Skip to main content
GET
List contacts

Authorizations

Authorization
string
header
required

User JWT bearer token. User principals can manage API keys and call tenant-scoped customer endpoints.

Query Parameters

leadSourceId

Unique identifier (UUID)

Pattern: ^[\da-f]{8}-[\da-f]{4}-[\da-f]{4}-[\da-f]{4}-[\da-f]{12}$
sortBy
enum<string>
Available options:
createdAt,
updatedAt,
firstName,
lastName,
companyName,
leadSourceName,
email,
phone,
totalJobs,
referenceNumber
sortDirection
enum<string>
Available options:
asc,
desc
offset
integer
Required range: 0 <= x <= 9007199254740991
limit
integer
Required range: 1 <= x <= 100

Response

200 - application/json

OK

items
object[]
required
total
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
offset
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
limit
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
hasMore
boolean
required