GET
/
v1
/
user-addresses
/
user
/
{userId}

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.

Path Parameters

userId
string
required

Fabric internal id of the record by default. If filterBy is sent, the search can be done by username or userId of the user, otherwise the user will be searched by _id.

Query Parameters

offset
integer
required

Number of records you wish to skip before selecting records.

limit
integer
required

Limits the number of records returned by the api.

filterBy
enum<string>
default: _id

-Optional. Filter field to search the user. If not sent, the user will be searched by _id.

Available options:
_id,
userId,
username

Response

200 - application/json
query
object
required
list
object[]
required

An array of items.

Was this page helpful?

Create user addressOverview