API reference · Clients
GET/api/v1/clients/{id}

Get client

Inherited ApiBaseController get route for one client_id.

RBAC · client

Path parameters

idstring <uuid>Required

Response body

Success response 200 · schema ClientEnvelope

dataobjectRequired
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
tax_id_numberstringRequiredNullable
notesstringRequiredNullable
propertiesobject
industrystring
company_sizestring
annual_revenuestring
primary_contact_idstring <uuid>
primary_contact_namestring
statusstring
typestring
billing_addressstring
tax_idstring
notesstring
payment_termsstring
websitestring <uri>
parent_client_idstring <uuid>
parent_client_namestring
last_contact_datestring <date-time>
logostring
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
logoUrlstringNullable
tenantstring <uuid>Required
tagsarray of string
itemsstring
metaobject

Response codes

200
Client returned.
400
Invalid client id format.
401
API key missing/invalid or key user not found.
403
Permission denied for client read.
404
Client not found.
500
Unexpected client retrieval failure.