List users by internal party

Authorizations

Authorization

string

header

required

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

internalPartyId

string

required

A unique idenifier for internalPartyId.

Query Parameters

offset

integer

required

The offset query parameter.

limit

integer

required

The limit query parameter.

Response

200 - application/json

data

object[]

required

An array of items.

Show child attributes

data._id

string

required

Fabric internal id of the record.

data.createdAt

string

required

date of creation of the record

data.isDeleted

boolean

required

flag that indicates if the record is deleted

data.updatedAt

string

required

laste date of update of the record

data.username

string

required

user name of the user. It must be UNIQUE.

data.additionalAttributes

object

Contains all additional attributes not captured in the schema.

data.email

string

email of the user

data.firstName

string

first name of the user

data.lastName

string

last name of the user

data.primaryPhone

string

primary phone of the usr

data.role

string

role of the user

data.status

enum<string>

status of the user. Default value will be PENDING.

Available options:

ACTIVE,

INACTIVE,

PENDING

data.title

string

title of the usr

data.userId

string

user identifier

query

object

required

Show child attributes

query.count

integer

required

Total number of rows

query.limit

integer

required

Limits the number of records returned by the api.

query.offset

integer

required

Number of records you wish to skip before selecting records.