User

Your employees, contractors and other users.

Operations

GET/v1/users/specGET/v1/usersPOST/v1/usersGET/v1/users/{userId}DELETE/v1/users/{userId}PATCH/v1/users/{userId}

---

OpenAPI Spec

GET

/v1/users/spec

Get OpenAPI 3.1.0 spec for User API

Responses

The spec itself as json

Content-Type

application/json

{

}

GET

/v1/users/spec

Playground

Samples

cURL

JavaScript

PHP

Python

---

List Users

GET

/v1/users

List Users

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Query Parameters

page

Typenumber

minimum0

default0

size

Typenumber

minimum1

maximum20

default10

fullName

email

shortName

roleId

Typenumber

roleType

staffNumber

externalId

createdAt

updatedAt

Responses

List response

Content-Type

application/json

{

"page": 0,

"pages": 0,

"size": 10,

"items": [

{

"id": 0,

"fullName": "string",

"email": "string",

"shortName": "string",

"staffNumber": "string",

"color": "#FFFFFF",

"roleId": 0,

"roleType": "string",

"createdAt": "string",

"updatedAt": "string",

"externalId": "string"

}

]

}

GET

/v1/users

Playground

Server

Authorization

apiKey

Variables

Key

Value

page

size

fullName

email

shortName

roleId

roleType

staffNumber

externalId

createdAt

updatedAt

Samples

cURL

JavaScript

PHP

Python

---

Create a new User

POST

/v1/users

Create a new User

Authorizations

apiKey

TypeHTTP (bearer)

Request Body

application/json

{

"fullName": "string",

"email": "string",

"password": "string",

"roleId": 0,

"shortName": "string",

"staffNumber": "string",

"color": "#FFFFFF",

"externalId": null

}

Responses

User found

Content-Type

application/json

{

"id": 0,

"fullName": "string",

"email": "string",

"shortName": "string",

"staffNumber": "string",

"color": "#FFFFFF",

"roleId": 0,

"roleType": "string",

"createdAt": "string",

"updatedAt": "string",

"externalId": "string"

}

POST

/v1/users

Playground

Server

Authorization

apiKey

Body

Samples

cURL

JavaScript

PHP

Python

---

Get a User

GET

/v1/users/{userId}

Get a User by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

userId*

Typeinteger

Required

formatint32

Responses

User found

Content-Type

application/json

{

"id": 0,

"fullName": "string",

"email": "string",

"shortName": "string",

"staffNumber": "string",

"color": "#FFFFFF",

"roleId": 0,

"roleType": "string",

"createdAt": "string",

"updatedAt": "string",

"externalId": "string"

}

GET

/v1/users/{userId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

userId*

Samples

cURL

JavaScript

PHP

Python

---

Delete a User

DELETE

/v1/users/{userId}

Delete a User by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

userId*

Typeinteger

Required

formatint32

Responses

Successfully removed

DELETE

/v1/users/{userId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

userId*

Samples

cURL

JavaScript

PHP

Python

---

Update a User

PATCH

/v1/users/{userId}

Update a User by ID

Authorizations

apiKey

TypeHTTP (bearer)

Parameters

Path Parameters

userId*

Typeinteger

Required

formatint32

Request Body

application/json

{

"fullName": "string",

"email": "string",

"password": "string",

"roleId": 0,

"shortName": "string",

"staffNumber": "string",

"color": "string",

"externalId": "string"

}

Responses

User found

Content-Type

application/json

{

"id": 0,

"fullName": "string",

"email": "string",

"shortName": "string",

"staffNumber": "string",

"color": "#FFFFFF",

"roleId": 0,

"roleType": "string",

"createdAt": "string",

"updatedAt": "string",

"externalId": "string"

}

PATCH

/v1/users/{userId}

Playground

Server

Authorization

apiKey

Variables

Key

Value

userId*

Body

Samples

cURL

JavaScript

PHP

Python

---