GET
/
v1
/
user-party
/
user
/
{userId}
/
party
/
{parentPartyId}

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

A unique idenifier for userId.

​
parentPartyId
string
required

A unique idenifier for parentPartyId.

Response

200 - application/json
​
_id
string
required

Fabric internal id of the record.

​
partyType
enum<string>
required

party type of the party. (H, O for organization party, P, C for person party)

Available options:
H,
O,
P,
C
​
isDeleted
boolean
required

flag that indicates if the record is deleted

​
createdAt
string
required

date of creation of the record

​
updatedAt
string
required

laste date of update of the record

​
parentPartyId
string

parent party id of the party (Internal fabric ID)

​
internalPartyId
string

Related internal party id (Internal fabric ID)

​
name
string

name of the party

​
isActive
boolean

status of the party

​
email
string

Email of the party

​
additionalAttributes
object

Contains all additional attributes not captured in the schema.

Was this page helpful?

Delete organizationList parties by user