Go to Syntho.AI

Users

get
Authorizations
sessionidstringRequired

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

Responses
200Success
application/json
get
/api/v1/users/
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
sessionidstringRequired

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

Body
first_namestring · max: 150Optional
last_namestring · max: 150Optional
emailstring · email · max: 255Required
is_adminbooleanOptional
Responses
post
/api/v1/users/
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-11-27T07:42:52.657Z",
  "password": "text"
}
get
Authorizations
sessionidstringRequired

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

Path parameters
idintegerRequired
Responses
200Success
application/json
get
/api/v1/users/{id}/
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
sessionidstringRequired

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

Path parameters
idintegerRequired
Body
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}/
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
sessionidstringRequired

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

Path parameters
idintegerRequired
Responses
delete
/api/v1/users/{id}/
DELETE /api/v1/users/{id}/ HTTP/1.1
Host: /
Accept: */*
204

No response body

No content
patch
Authorizations
sessionidstringRequired

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

Path parameters
idintegerRequired
Body
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}/
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
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/
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-11-27T07:42:52.657Z",
  "password": "text"
}
get
Authorizations
sessionidstringRequired

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

Responses
200Success
application/json
get
/api/v1/users/me/
GET /api/v1/users/me/ HTTP/1.1
Host: /
Accept: */*
200Success
{
  "pk": 1,
  "created": "2025-11-27T07:42:52.657Z",
  "first_name": "text",
  "last_name": "text",
  "full_name": "text",
  "email": "[email protected]",
  "is_admin": true,
  "new_password_required": true
}
patch
Authorizations
sessionidstringRequired

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

Body
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/
PATCH /api/v1/users/me/ HTTP/1.1
Host: /
Content-Type: application/json
Accept: */*
Content-Length: 19

{
  "password": "text"
}
200Success
{
  "pk": 1,
  "created": "2025-11-27T07:42:52.657Z",
  "first_name": "text",
  "last_name": "text",
  "full_name": "text",
  "email": "[email protected]",
  "is_admin": true,
  "new_password_required": true
}
PreviousTableListNextWorkspace Permissions

Last updated

Was this helpful?