Skip to main content
GET
Search contacts

Authorizations

Authorization
string
header
required

Behalf of an Operator (default). A JWT issued by Talqui Core when an operator signs in, scoped to every tenant that operator belongs to. Send as Authorization: Bearer <jwt-token>.

Path Parameters

tenantID
string<uuid>
required

The tenant whose contacts are searched.

Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Query Parameters

Free-text term. Every word must prefix the first or the last name; email and phone match the whole term. A bare 12-hex-character term is also looked up as a conversation protocol.

Required string length: 1 - 120
filters
string

JSON-encoded array of typed filter rules (same vocabulary as the campaign audience), "contact" schema only, at most 20. Combined with AND.

Maximum string length: 8000
tag
string

Only contacts carrying this exact tag.

Required string length: 1 - 120
channel
string

Only contacts with a contactChannels URN containing this term — whatsapp covers every WhatsApp flavour, a full URN matches that channel.

Required string length: 1 - 64
sortBy
enum<string>
default:createdAt

Sort field. Text sorts are accent/case-insensitive and put contacts without the value last.

Available options:
createdAt,
updatedAt,
contactFirstname,
contactEmail
sortDesc
enum<string>
default:-1

-1 descending (default), 1 ascending.

Available options:
1,
-1
page
integer
default:1

1-indexed page number to fetch.

Required range: 1 <= x <= 9007199254740991
perPage
integer
default:50

Number of contacts per page (max 200).

Required range: 1 <= x <= 200

Response

Response for status 200.

data
object[]
required

One page of contacts in the requested order; protocol hits (page 1 only) come first.

meta
object
required

Pagination metadata.