API reference · Contacts
GET/api/v1/contacts/search
Product availabilityAlgaPSAAlgaDesk

Search contacts

Runs advanced contact search with explicit API-key auth and contact:read permission check.

RBAC · contact

Query parameters

querystringRequired
fieldsstringOptional
Comma-separated field list; parsed by contactSearchSchema transform.
client_idstring <uuid>Optional
include_inactivestringOptional
limitstringOptional

Response body

Success response 200 · schema ContactSearchEnvelope

dataarray of ContactResourceRequired
itemsobject
contact_name_idstring <uuid>Required
full_namestringRequired
client_idstring <uuid>RequiredNullable
emailstring <email>Required
rolestringRequiredNullable
created_atstring <date-time>Required
updated_atstring <date-time>Required
is_inactivebooleanRequired
tenantstring <uuid>Required
phone_numbersarray of object
itemsobject
contact_phone_number_idstring <uuid>Required
phone_numberstringRequired
normalized_phone_numberstringRequired
canonical_typestringNullable
custom_phone_type_idstring <uuid>Nullable
custom_typestringRequiredNullable
is_defaultbooleanRequired
display_orderintegerRequired
≥ 0
additional_email_addressesarray of object
itemsobject
contact_additional_email_address_idstring <uuid>Required
email_addressstring <email>Required
normalized_email_addressstring <email>Required
canonical_typestringNullable
custom_email_type_idstring <uuid>Nullable
custom_typestringRequiredNullable
display_orderintegerRequired
≥ 0
default_phone_numberstringNullable
default_phone_typestringNullable
primary_email_canonical_typestringNullable
primary_email_custom_type_idstring <uuid>Nullable
primary_email_typestringNullable
notesstringNullable
avatarUrlstringNullable
tagsarray of string
itemsstring
client_namestringNullable
metaobject

Response codes

200
Contact search results returned.
400
Invalid search query.
401
API key missing/invalid or key user not found.
403
Permission denied for contact read.
500
Unexpected contact search failure.