Skip to main content
GET
Search contacts

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 12-hex-character term is also looked up as a conversation protocol.

Required string length: 1 - 120
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

Contacts matching the term, newest first; protocol hits (page 1 only) come first.

meta
object
required

Pagination metadata.