Get All Contacts

Get all Contacts in an Academy. Results can be filtered by name, email, email domain, status, and custom registration fields. All filters combine with AND. By default, both Active and Deactivated Contacts are returned, including Contacts with a pending invitation. Results are always sorted by email, ascending.

Path Params
string
required

The id of the Academy

Query Params
int32
Defaults to 1

The page number of the results

int32
Defaults to 20

The number of results returned per page

string

Optional. Returns Contacts whose name contains this value (case-insensitive, partial match).

string

Optional. Returns Contacts whose email address contains this value (case-insensitive partial match). For example, [email protected] also matches [email protected]. To match one address exactly, use exact_email.

string

Optional. Returns Contacts whose email address ends in exactly @<value> (case-insensitive). Subdomains are not included: example.com does not match [email protected].

string

Optional. Returns only the Contact whose email address exactly matches this value. Matching is case-insensitive, and surrounding whitespace is ignored. No partial matching is performed. When exact_email is provided, the email and email_domain parameters are ignored.

string
enum

Optional. Active returns only active Contacts; Deactivated returns only deactivated Contacts. If omitted, both are returned.

Allowed:
string

Optional object with a single key-value pair where the key represents the custom registration field name and the value represents the custom attribute field value. (e.g. custom_registration_fields%5Bnickname%5D=Bobby ) -- NOTE: This tool can't generate this parameter for you because the parameter name itself (such as custom_registration_fields[example]) is dynamic.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json