Appearance
User
A company's employees, contractors and other users. Each has a Role, which decides what they may do in Artesa; one with an email and password can log in.
OpenAPI Spec
List Users
GET
/v2/users
List Users
Authorizations
apiKey
Type
HTTP (bearer)
Parameters
Query Parameters
page
Type
number
Minimum
0Default
0size
Type
number
Minimum
1Maximum
20Default
10uuid
roleUuid
fullName
email
shortName
roleType
staffNumber
deactivatedAt
externalId
createdAt
updatedAt
Responses
List response
application/json
JSON "page": 0, "pages": 0, "size": 10, "items": [ { "uuid": "string", "fullName": "string", "email": "string", "shortName": "string", "staffNumber": "string", "color": "string", "roleType": "string", "deactivatedAt": "string", "createdAt": "string", "updatedAt": "string", "externalId": "string", "roleUuid": "string" } ]
{
}
Create a new User
POST
/v2/users
Create a new User
Authorizations
apiKey
Type
HTTP (bearer)
Request Body
application/json
JSON "uuid": "string", "fullName": "string", "email": "string", "password": "string", "shortName": "string", "staffNumber": "string", "color": "#FFFFFF", "deactivatedAt": "string", "externalId": null, "roleUuid": "string"
{
}
Responses
User found
application/json
JSON "uuid": "string", "fullName": "string", "email": "string", "shortName": "string", "staffNumber": "string", "color": "string", "roleType": "string", "deactivatedAt": "string", "createdAt": "string", "updatedAt": "string", "externalId": "string", "roleUuid": "string"
{
}
Get a User
GET
/v2/users/{userUuid}
Get a User by ID
Authorizations
apiKey
Type
HTTP (bearer)
Parameters
Path Parameters
userUuid*
Type
Requiredstring
Format
"uuid"Responses
User found
application/json
JSON "uuid": "string", "fullName": "string", "email": "string", "shortName": "string", "staffNumber": "string", "color": "string", "roleType": "string", "deactivatedAt": "string", "createdAt": "string", "updatedAt": "string", "externalId": "string", "roleUuid": "string"
{
}
Update a User
PATCH
/v2/users/{userUuid}
Update a User by ID
Authorizations
apiKey
Type
HTTP (bearer)
Parameters
Path Parameters
userUuid*
Type
Requiredstring
Format
"uuid"Request Body
application/json
JSON "fullName": "string", "email": "string", "password": "string", "shortName": "string", "staffNumber": "string", "color": "string", "deactivatedAt": "string", "externalId": "string"
{
}
Responses
User found
application/json
JSON "uuid": "string", "fullName": "string", "email": "string", "shortName": "string", "staffNumber": "string", "color": "string", "roleType": "string", "deactivatedAt": "string", "createdAt": "string", "updatedAt": "string", "externalId": "string", "roleUuid": "string"
{
}