GET
/
v1
/
parties

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.

partyType
enum<string>

-Optional. Party type.

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

-Optional. Global customer id.

customerContactId
string

-Optional. Customer contact id.

custType
string

-Optional. Cust type.

createdAt[from]
string

-Optional. Filter by createdAt using a date range. Must be accompanied by createdAt[to].

createdAt[to]
string

-Optional. Filter by createdAt using a date range. Must be accompanied by createdAt[from].

updatedAt[from]
string

-Optional. Filter by updatedAt using a date range. Must be accompanied by updatedAt[to].

updatedAt[to]
string

-Optional. Filter by updatedAt using a date range. Must be accompanied by updatedAt[from].

Response

200 - application/json

Sample query parameters.

query
object

Contains data about pagination

data
object[]

list of parties to be retrieved

Was this page helpful?

Create partyGet party