Clients API
GET/api/v1/clients
Product availabilityAlgaPSAAlgaDesk

List clients

Inherited ApiBaseController list route for clients. Requires API-key auth and client:read permission.

RBAC · client

Query parameters

pagestringOptional
limitstringOptional
sortstringOptional
orderstringOptional
searchstringOptional
created_fromstring <date-time>Optional
created_tostring <date-time>Optional
updated_fromstring <date-time>Optional
updated_tostring <date-time>Optional
client_namestringOptional
emailstringOptional
client_typestringOptional
billing_cyclestringOptional
is_inactivestringOptional
Filters to inactive clients when true and active clients when false; omit to include all clients.
is_tax_exemptstringOptional
account_manager_idstring <uuid>Optional
region_codestringOptional
credit_balance_minstringOptional
credit_balance_maxstringOptional
has_credit_limitstringOptional
industrystringOptional
company_sizestringOptional

Response body

Success response 200 · schema PaginatedClientEnvelope

dataarray of objectRequired
itemsobject
client_idstring <uuid>Required
client_namestringRequired
phone_nostringRequiredNullable
credit_balancenumberRequired
emailstringRequiredNullable
urlstringRequiredNullable
addressstringRequiredNullable
created_atstring <date-time>Required
updated_atstring <date-time>Required
is_inactivebooleanRequired
client_typestringRequiredNullable
Enum: companyindividualnull
tax_id_numberstringRequiredNullable
notesstringRequiredNullable
propertiesobject
industrystring
company_sizestring
annual_revenuestring
primary_contact_idstring <uuid>
primary_contact_namestring
statusstring
typestring
billing_addressstring
notesstring
payment_termsstring
websitestring
parent_client_idstring <uuid>
parent_client_namestring
last_contact_datestring <date-time>
logostring
defaultLocalestring
payment_termsstringRequiredNullable
billing_cyclestringRequired
Enum: weeklybi-weeklymonthlyquarterlysemi-annuallyannually
credit_limitnumberRequiredNullable
preferred_payment_methodstringRequiredNullable
auto_invoicebooleanRequired
invoice_delivery_methodstringRequiredNullable
region_codestringRequiredNullable
is_tax_exemptbooleanRequired
tax_exemption_certificatestringRequiredNullable
timezonestringRequiredNullable
invoice_template_idstring <uuid>RequiredNullable
billing_contact_idstring <uuid>RequiredNullable
billing_emailstringRequiredNullable
account_manager_idstring <uuid>RequiredNullable
account_manager_full_namestringNullable
client_sincestringNullable
lifecycle_statusstring
Enum: prospectactiveformer
logoUrlstringNullable
tenantstring <uuid>Required
tagsarray of string
itemsstring
paginationobjectRequired
pageintegerRequired
limitintegerRequired
totalintegerRequired
totalPagesintegerRequired
hasNextbooleanRequired
hasPrevbooleanRequired
metaobject

Response codes

200
Paginated clients returned.
400
Invalid query parameters.
401
API key missing/invalid or key user not found.
403
Permission denied for client read.
500
Unexpected client listing failure.