Party
Get party with type
GET
/
v1
/
parties
/
{globalCustomerId}
/
{partyType}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
x-site-context
string
requiredThe 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
globalCustomerId
number
requiredThe global customer id you want to fetch.
partyType
enum<string>
requiredThe party type you want to fetch
Available options:
H
, O
, P
, C
Response
200 - application/json
isDeleted
boolean
requiredpartyType
enum<string>
requiredAvailable options:
H
, O
, P
, C
email
string
required_id
string
Fabric internal id of the record.
internalPartyId
string
Related internal party id (Internal fabric ID)
additionalAttributes
object
Contains all additional attributes not captured in the schema.
Was this page helpful?