Skip to main content
GET
Search contacts

Authorizations

Authorization
string
header
required

Headers

Quo-Api-Version
enum<string>
required

API version header. Supported values: 2026-03-30

Available options:
2026-03-30

Query Parameters

query
string | null

Free text matched by keyword and by meaning against contact names, companies and phone numbers, such as query=jane or query=0100. Up to 100 characters, case-insensitive. Leave it out to return the contacts that match the filters.

Required string length: 1 - 100
Example:

"jane"

phoneNumber

Only return contacts with this exact E.164 phone number, such as phoneNumber=+15555555555. To match any of several, use phoneNumber[in]=+15555555555,+15555555556. For part of a number, use query.

Pattern: ^\+[1-9]\d{1,14}$
Example:

"+15555555555"

email

Only return contacts with this exact email address, such as email=jane@example.com. To match any of several, use email[in]=jane@example.com,john@example.com.

Example:

"jane@example.com"

company

Only return contacts at this company, matched exactly, including capitalization, such as company=Acme (it does not match Acme Inc or ACME). To match any of several, use company[in]=Acme,Globex. To match a company name loosely, put it in query.

Minimum string length: 1
Example:

"Acme"

source

Filter by source label, such as source=openphone-hubspot. To match any of several, use source[in]=openphone-hubspot,openphone-salesforce.

Minimum string length: 1
Example:

"openphone-hubspot"

createdAt
object | null

Bound the results by creation time, in ISO 8601 format: createdAt[gte]=2022-01-01T00:00:00Z&createdAt[lte]=2022-02-01T00:00:00Z. Both bounds are inclusive.

Example:
limit
integer | null
default:50

Page size. Search returns at most 50 contacts, the only value accepted.

Required range: 50 <= x <= 50

Response

OK

data
object[]
required
nextCursor
string | null
required

Cursor for the next page, or null when there are no more pages.

Example:

"eyJsYXN0SWQiOiJVU211a09NaXBhIn0"