Skip to main content
GET
List addresses for a profile

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Authorization
string
required

Bearer token

Path Parameters

profile_id
string
required

Query Parameters

include
string

Comma-separated list of relationships to include. Allowed: user, profile

sort
string

Sort order. Prefix with - for descending. Allowed: created_at, updated_at

filter[key]
string

Filter results. Available filters: created_at, created_at.neq, created_at.lt, created_at.lte, created_at.gt, created_at.gte, updated_at, updated_at.neq, updated_at.lt, updated_at.lte, updated_at.gt, updated_at.gte, is_current (boolean, Limit to currently-effective records.), external_id, external_id.neq, external_id.cont (case-insensitive substring match), external_id.in (list of values, comma-separated), external_id.nin (list of values, comma-separated), country, country.neq, country.cont (case-insensitive substring match), country.in (list of values, comma-separated), country.nin (list of values, comma-separated), postal_code, postal_code.neq, postal_code.cont (case-insensitive substring match), postal_code.in (list of values, comma-separated), postal_code.nin (list of values, comma-separated), effective_from, effective_from.neq, effective_from.lt, effective_from.lte, effective_from.gt, effective_from.gte, effective_to, effective_to.neq, effective_to.lt, effective_to.lte, effective_to.gt (null values are treated as unbounded above and match this filter), effective_to.gte (null values are treated as unbounded above and match this filter), user, profile, profile.exists (boolean). Filter by a custom field with filter[custom_fields][<key>]=<value>. The neq, cont, in, nin, lt, lte, gt, and gte operators take the form filter[custom_fields.<operator>][<key>]=<value>, where the field's type decides which apply.

page[size]
integer

Number of items per page (max 100)

page[after]
string

Cursor for next page

page[before]
string

Cursor for previous page

Response

addresses found

data
object[]
required
meta
object