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

The unique idenifier for userId.

Query Parameters

​
offset
integer
required

The offset query parameter.

​
limit
integer
required

The limit query parameter.

​
sortBy
enum<string>

-Optional. Default:updatedAt. Return the sorted records based on this field.

Available options:
updatedAt,
createdAt
​
sortOrder
enum<string>

-Optional. Default:desc. Return the records order based on this field.

Available options:
desc,
asc

Response

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

An array of items.

Was this page helpful?

Get party by user and parent partyUnlink user from party