users

List Users

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
format
string
Enum: "csv" "json"
is_active
boolean
location
string
order_by
string

Which field to use when ordering the results.

page
integer

A page number within the paginated result set.

page_size
integer

Number of results to return per page.

pending_invite
boolean
permission
string
role
integer
search
string

A search term.

Responses
200
Response Schema:
object
Array of objects (UserProfileUnoptimized)
get/api/v3/users/
Response samples
{
  • "metadata": {
    },
  • "data": [
    ]
}

Create New User

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
format
string
Enum: "csv" "json"
Request Body schema:
required
Array
email
required
string <email> non-empty
send_invitation_email
boolean
Default: true
first_name
string
Default: ""
last_name
string
Default: ""
phone
string
Default: ""
position
string
Default: ""
role_id
integer >= 0
Default: 0
all_locations
boolean
Default: false
Array of objects (LocationIdValidationSerializersRequest)
Default: []
home_department
integer >= 0
Default: 0
home_location
integer >= 0
Default: 0
Responses
201
Response Schema:
object
Default: {}
required
Array of objects (UserProfileUnoptimized)
post/api/v3/users/
Request samples
[
  • {
    }
]
Response samples
{
  • "metadata": { },
  • "data": [
    ]
}

Update User

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
path Parameters
id
required
integer

A unique integer value identifying this user profile.

query Parameters
format
string
Enum: "csv" "json"
Request Body schema:
required
id
integer
user
integer
email
required
string <email> [ 1 .. 254 ] characters
firstName
required
string non-empty
lastName
required
string non-empty
location
required
integer or null
department
required
integer or null
position
string
Default: ""
phone
string
Default: ""
profile_image
string or null
is_sso_enabled
boolean
Default: false
mark_for_skip
boolean
Default: false
mark_for_delete
boolean
Default: false
Responses
200
Response Schema:
object
Default: {}
required
object (UserProfileUnoptimized)
put/api/v3/users/{id}/
Request samples
{
  • "id": 0,
  • "user": 0,
  • "email": "user@example.com",
  • "firstName": "string",
  • "lastName": "string",
  • "location": 0,
  • "department": 0,
  • "position": "",
  • "phone": "",
  • "profile_image": "string",
  • "is_sso_enabled": false,
  • "mark_for_skip": false,
  • "mark_for_delete": false
}
Response samples
{
  • "metadata": { },
  • "data": {
    }
}

Deactivate User

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
path Parameters
id
required
integer

A unique integer value identifying this user profile.

query Parameters
format
string
Enum: "csv" "json"
Responses
204

No response body

delete/api/v3/users/{id}/

Get Logged-in User

Get the logged in user account information

SecurityRemoteAuthentication or M2MAuthentication or BasicAuthentication or cookieAuth
Request
query Parameters
format
string
Enum: "csv" "json"
Responses
200
Response Schema:
object
Default: {}
required
object (UserProfileMe)
get/api/v3/users/me/
Response samples
{
  • "data": {
    },
  • "metadata": { }
}
➔ Next to locations