Skip to main content
GET
Get Contacts in Invitation List

Authorizations

Authorization
string
header
required

OAuth 2.0 bearer token obtained from POST /oauth2/token. Tokens expire after 30 minutes. Include in the Authorization header as Bearer {access_token}.

Path Parameters

invitation_list_id
integer
required

integer - required - The ID of the invitation list

Example:

34

Query Parameters

fields
string

string - optional - Comma-separated list of fields to return. Allowed values: contact_id, status. Defaults to contact_id,status.

Example:

"contact_id,status"

string - optional - Filter conditions to narrow the results. Valid operators are =, !=, >=, <=, >, <, contains, beginswith, endswith

Example:

"id>123"

page
string

integer - optional - The page of results you want to view

Example:

"1"

per-page
string

integer - optional - The number of results per page (to a max of 1000)

Example:

"20"

sort
string

string - optional - Sort field. Allowed values: contact_id, status, event_id. Prefix with - for descending order (e.g. -contact_id). Defaults to contact_id ascending.

Example:

"contact_id"

expand
string

string - optional - Comma-separated list of related objects to embed. Allowed value: contact (includes the full contact record).

Example:

"contact"

Response

Collection

items
object[]
_meta
object