GET
/
v1
/
addresses

Authorizations

Authorization
string
headerrequired

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

Headers

x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Query Parameters

offset
integer

-Optional. Default:0. Number of records you wish to skip before selecting records.

limit
integer

-Optional. Default:10. Limits the number of records returned by the api.

id
string

-Optional. Fabric internal id for address.

globalAddressId
string

-Optional. Global address id of the address.

type
enum<string>

-Optional. Type of the address. M=Mail, E=Email, P=Postal

Available options:
M,
E,
P
filterField
string

-Optional. Must be used in combination with filterValue. Especifies a particular field to filter on.

filterValue
string

-Optional. Must be used in combination with filterField. Especifies the value of the field determined in filterValue.

Response

200 - application/json
query
object

it contains data about pagination

data
object[]

list of users to be retrieved

Was this page helpful?

OverviewGet address