Users

get

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Responses

200Success

application/json

get

/api/v1/users/

HTTPcURLJavaScriptPython

GET /api/v1/users/ HTTP/1.1
Host: /
Accept: */*

200Success

[
  {
    "pk": 1,
    "first_name": "text",
    "last_name": "text",
    "full_name": "text",
    "email": "[email protected]"
  }
]

post

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Body

application/json

first_namestring · max: 150Optional

last_namestring · max: 150Optional

emailstring · email · max: 255Required

is_adminbooleanOptional

Responses

201

Success: User created

application/json

post

/api/v1/users/

HTTPcURLJavaScriptPython

POST /api/v1/users/ HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 81

{
  "first_name": "text",
  "last_name": "text",
  "email": "[email protected]",
  "is_admin": true
}

201

Success: User created

{
  "pk": 1,
  "first_name": "text",
  "last_name": "text",
  "full_name": "text",
  "email": "[email protected]",
  "is_admin": true,
  "new_password_required": true,
  "owned_workspaces": 1,
  "created": "2025-12-24T13:16:54.887Z",
  "password": "text"
}

get

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

idintegerRequired

Responses

200Success

application/json

get

/api/v1/users/{id}/

HTTPcURLJavaScriptPython

GET /api/v1/users/{id}/ HTTP/1.1
Host: /
Accept: */*

200Success

{
  "pk": 1,
  "first_name": "text",
  "last_name": "text",
  "full_name": "text",
  "email": "[email protected]"
}

put

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

idintegerRequired

Body

application/json

pkintegerRead-onlyOptional

first_namestring · max: 150Optional

last_namestring · max: 150Optional

full_namestringRead-onlyOptional

Return the first_name plus the last_name, with a space in between.

emailstring · email · max: 255Required

Responses

200Success

application/json

put

/api/v1/users/{id}/

HTTPcURLJavaScriptPython

PUT /api/v1/users/{id}/ HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 65

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

200Success

{
  "pk": 1,
  "first_name": "text",
  "last_name": "text",
  "full_name": "text",
  "email": "[email protected]"
}

delete

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

idintegerRequired

Responses

204

No response body

delete

/api/v1/users/{id}/

HTTPcURLJavaScriptPython

DELETE /api/v1/users/{id}/ HTTP/1.1
Host: /
Accept: */*

204

No response body

No content

patch

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

idintegerRequired

Body

application/json

pkintegerRead-onlyOptional

first_namestring · max: 150Optional

last_namestring · max: 150Optional

full_namestringRead-onlyOptional

Return the first_name plus the last_name, with a space in between.

emailstring · email · max: 255Optional

Responses

200Success

application/json

patch

/api/v1/users/{id}/

HTTPcURLJavaScriptPython

PATCH /api/v1/users/{id}/ HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 65

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

200Success

{
  "pk": 1,
  "first_name": "text",
  "last_name": "text",
  "full_name": "text",
  "email": "[email protected]"
}

post

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Path parameters

idintegerRequired

Responses

200

Success: Password reset

application/json

post

/api/v1/users/{id}/reset-password/

HTTPcURLJavaScriptPython

POST /api/v1/users/{id}/reset-password/ HTTP/1.1
Host: /
Accept: */*

200

Success: Password reset

{
  "pk": 1,
  "first_name": "text",
  "last_name": "text",
  "full_name": "text",
  "email": "[email protected]",
  "is_admin": true,
  "new_password_required": true,
  "owned_workspaces": 1,
  "created": "2025-12-24T13:16:54.887Z",
  "password": "text"
}

get

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Responses

200Success

application/json

get

/api/v1/users/me/

HTTPcURLJavaScriptPython

GET /api/v1/users/me/ HTTP/1.1
Host: /
Accept: */*

200Success

{
  "pk": 1,
  "created": "2025-12-24T13:16:54.887Z",
  "first_name": "text",
  "last_name": "text",
  "full_name": "text",
  "email": "[email protected]",
  "is_admin": true,
  "new_password_required": true
}

patch

Authorizations

authenticationOIDC

sessionidstringRequired

Log in using the POST /api/v1/auth/ endpoint

Body

application/json

pkintegerRead-onlyOptional

createdstring · date-time | nullableRead-onlyOptional

first_namestringRead-onlyOptional

last_namestringRead-onlyOptional

full_namestringRead-onlyOptional

Return the first_name plus the last_name, with a space in between.

emailstring · emailRead-onlyOptional

is_adminbooleanRead-onlyOptional

new_password_requiredbooleanRead-onlyOptional

passwordstring · max: 128Write-onlyOptional

Responses

200Success

application/json

patch

/api/v1/users/me/

HTTPcURLJavaScriptPython

PATCH /api/v1/users/me/ HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "password": "text"
}

200Success

{
  "pk": 1,
  "created": "2025-12-24T13:16:54.887Z",
  "first_name": "text",
  "last_name": "text",
  "full_name": "text",
  "email": "[email protected]",
  "is_admin": true,
  "new_password_required": true
}