Skip to main content
POST
Search contacts

Authorizations

Authorization
string
header
required

A workspace API token. Create one in Settings → API. Send it as Authorization: Bearer sk_live_....

Body

application/json

Body for POST /v1/contacts/search, and arguments for the MCP search_records tool.

Defined here rather than beside the route because two surfaces share it. The MCP tool derives its JSON Schema from this class, so a filter added for REST reaches the tool in the same commit — there is no second copy to forget.

Extras are forbidden for the same reason they are on FilterCondition: every field here is optional, so an ignored filtr typo would silently mean "no filter" and return the whole collection with 200 OK.

cursor
string | null
expand
string | null
fields
string | null
filter
FilterGroup · object

A set of conditions combined with and / or. Groups may nest.

limit
integer
default:50
Required range: 1 <= x <= 200
q
string | null

Free text across name, email and phone.

sort
string | null

Same syntax as the sort query parameter.

Response

Successful Response

A page of contacts.

A named subclass purely so the generated SDK type is ContactList rather than the Page_Contact_ FastAPI derives from the generic.

data
Contact · object[]
required
meta
PageMeta · object
required