List Contacts

get

https://api.scalepad.com/quoter/v1/contacts

Retrieves a list of contacts. Supports filtering by canonical V2 fields (id, client.id, billing_email, first_name, last_name, phone, organization, address, city, country, region, postal_code, record_created_at, record_updated_at) using the query-string filter syntax filter[field]=operator:value. Lookup by billing email + client id is expressed as filter[billing_email]=eq:<email>&filter[client.id]=eq:<client_id>. filter[email] is accepted as a deprecated alias for filter[billing_email].

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

fields

string

^[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*(,[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*)*$

Sparse-fieldset selector. Comma-separated list of Contact fields to
include in the response. Omit to return all fields.

Allowed fields: billing_address, billing_email, billing_first_name,
billing_last_name, billing_mobile_phone, billing_organization,
billing_work_phone, client, id, record_created_at,
record_updated_at, shipping_address, shipping_email,
shipping_first_name, shipping_label, shipping_last_name,
shipping_organization, shipping_phone, title, website.

sort

string

^[+-]?(record_created_at|record_updated_at|id|billing_first_name|billing_last_name)(,[+-]?(record_created_at|record_updated_at|id|billing_first_name|billing_last_name))*$

Comma-separated list of sort fields. Prefix with + (ascending, default)
or - (descending). Allowed fields: record_created_at,
record_updated_at, id, billing_first_name, billing_last_name.

filter[id]

string

^eq:.+$

Filter by contact id.

Operators: eq

Examples

filter[id]=eq:1g4123ty-4er6-4g3t-a345-wfe5e5234rfd

filter[client.id]

string

^eq:.+$

Filter by client id. Combine with filter[billing_email] to locate
a contact by the billing email + client id pair.

Operators: eq

Examples

filter[client.id]=eq:00000ae5-h3r7-6468-er45-wiuynj9c0d23

filter[billing_email]

string

^(cont|eq):.+$

Filter by billing_email. Combine with filter[client.id] for
tuple lookup.

Operators: eq, cont

Examples

filter[billing_email]=eq:[email protected]
filter[billing_email]=cont:example

filter[email]

string

^(cont|eq):.+$

deprecated

Deprecated. Alias for filter[billing_email]. Prefer
filter[billing_email] for new integrations.

Operators: eq, cont

filter[first_name]

string

^(cont|eq):.+$

Filter by first_name.

Operators: eq, cont

filter[last_name]

string

^(cont|eq):.+$

Filter by last_name.

Operators: eq, cont

filter[phone]

string

^(cont|eq):.+$

Filter by phone.

Operators: eq, cont

filter[organization]

string

^(cont|eq):.+$

Filter by organization.

Operators: eq, cont

filter[address]

string

^(cont|eq):.+$

Filter by billing address.

Operators: eq, cont

filter[city]

string

^(cont|eq):.+$

Filter by billing city.

Operators: eq, cont

filter[country]

string

^eq:.+$

Filter by billing country ISO code.

Operators: eq

filter[region]

string

^eq:.+$

Filter by billing region code.

Operators: eq

filter[postal_code]

string

^(cont|eq):.+$

Filter by billing postal_code.

Operators: eq, cont

filter[record_created_at]

string

^(eq|gt|lt):.+$

Filter by record creation timestamp.

Operators: eq, gt, lt

Examples

filter[record_created_at]=gt:2024-01-01T00:00:00Z

filter[record_updated_at]

string

^(eq|gt|lt):.+$

Filter by record update timestamp.

Operators: eq, gt, lt

page_size

int32

1 to 200

Number of records returned per page.

cursor

string

Cursor for pagination (from previous response's next_cursor).

Responses

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Contacts found.

401Unauthorized. Invalid or missing authentication.

422Validation error in request.