GET
/
v1
/
party-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 party-address.

partyType
enum<string>

-Optional. Party type of the party.

Available options:
O,
H,
P,
C
globalCustomerId
string

-Optional. Global customer id.

globalAddressId
string

-Optional. Global address id.

isActive
boolean

-Optional. Flag.

Response

200 - application/json
query
object

it contains data about pagination

data
object

Was this page helpful?

Link party and addressOverview