Users

Manage users inside the current organisation.

List Users

get

List all users in the current organisation.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Responses

200

Successful Response

application/json

idstring · uuidRequired

emailstringRequired

rolestringRequired

first_nameany ofRequired

stringOptional

or

nullOptional

last_nameany ofRequired

stringOptional

or

nullOptional

organisation_idany ofRequired

string · uuidOptional

or

nullOptional

is_activebooleanRequired

get

/users

HTTPcURLJavaScriptPython

GET /users HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200

Successful Response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "email": "text",
    "role": "text",
    "first_name": "text",
    "last_name": "text",
    "organisation_id": "123e4567-e89b-12d3-a456-426614174000",
    "is_active": true
  }
]

Invite User

post

Invite a new user to the organisation. Admin only.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

emailstring · emailRequired

passwordstringRequired

rolestringOptionalDefault: preparer

first_nameany ofOptional

stringOptional

or

nullOptional

last_nameany ofOptional

stringOptional

or

nullOptional

Responses

201

Successful Response

application/json

422

Validation Error

application/json

post

/users

HTTPcURLJavaScriptPython

POST /users HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "email": "[email protected]",
  "password": "text",
  "role": "preparer",
  "first_name": "text",
  "last_name": "text"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "text",
  "role": "text",
  "first_name": "text",
  "last_name": "text",
  "organisation_id": "123e4567-e89b-12d3-a456-426614174000",
  "is_active": true
}

Get User

get

Get a single user by ID.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

user_idstring · uuidRequired

Responses

200

Successful Response

application/json

idstring · uuidRequired

emailstringRequired

rolestringRequired

first_nameany ofRequired

stringOptional

or

nullOptional

last_nameany ofRequired

stringOptional

or

nullOptional

organisation_idany ofRequired

string · uuidOptional

or

nullOptional

is_activebooleanRequired

422

Validation Error

application/json

get

/users/{user_id}

HTTPcURLJavaScriptPython

GET /users/{user_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "text",
  "role": "text",
  "first_name": "text",
  "last_name": "text",
  "organisation_id": "123e4567-e89b-12d3-a456-426614174000",
  "is_active": true
}

Deactivate User

delete

Deactivate a user (soft delete). Admin only.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

user_idstring · uuidRequired

Responses

204

Successful Response

422

Validation Error

application/json

delete

/users/{user_id}

HTTPcURLJavaScriptPython

DELETE /users/{user_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Update User

patch

Update a user's role, name, or active status. Admin only.

Authorizations

HTTPBearer

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

user_idstring · uuidRequired

Body

application/json

roleany ofOptional

stringOptional

or

nullOptional

first_nameany ofOptional

stringOptional

or

nullOptional

last_nameany ofOptional

stringOptional

or

nullOptional

is_activeany ofOptional

booleanOptional

or

nullOptional

Responses

200

Successful Response

application/json

idstring · uuidRequired

emailstringRequired

rolestringRequired

first_nameany ofRequired

stringOptional

or

nullOptional

last_nameany ofRequired

stringOptional

or

nullOptional

organisation_idany ofRequired

string · uuidOptional

or

nullOptional

is_activebooleanRequired

422

Validation Error

application/json

patch

/users/{user_id}

HTTPcURLJavaScriptPython

PATCH /users/{user_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 71

{
  "role": "text",
  "first_name": "text",
  "last_name": "text",
  "is_active": true
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "email": "text",
  "role": "text",
  "first_name": "text",
  "last_name": "text",
  "organisation_id": "123e4567-e89b-12d3-a456-426614174000",
  "is_active": true
}