GET
/
v1
/
users
/
{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

Fabric internal id of the user to update.

Query Parameters

filterBy
enum<string>

the field in which you want to filter by.

Available options:
userId

Response

200 - application/json
_id
string

Fabric internal id of the record

username
string

user name of the user. It must be UNIQUE.

userId
string

user identifier

title
string

title of the usr

firstName
string

first name of the user

lastName
string

last name of the user

email
string

email of the user

primaryPhone
string

primary phone of the usr

status
enum<string>

status of the user. Default value will be PENDING.

Available options:
ACTIVE,
INACTIVE,
PENDING
role
string

role of the user

additionalAttributes
object

Contains all additional attributes not captured in the schema.

isDeleted
boolean

flag that indicates if the record is deleted

createdAt
string

date of creation of the record

updatedAt
string

laste date of update of the record

Was this page helpful?

Update userUse pre signed url to upload a user