Compozy Symbol
ALPHA
DocsInstallGetting StartedFeaturesPricing
CoreCLI ReferenceSchema DefinitionAPI Reference

Users

User management operations (admin only)

User management operations (admin only)

List all users (admin only)

List all users in the system

GET
/users

Header Parameters

Authorizationstring

Bearer token for authentication (admin required)

Response Body

curl -X GET "https://loading/api/v0/users" \
  -H "Authorization: string"
{}
{
  "property1": "string",
  "property2": "string"
}
{
  "property1": "string",
  "property2": "string"
}
{
  "property1": "string",
  "property2": "string"
}

Create a new user (admin only)

Create a new user with the specified email and role

POST
/users

Header Parameters

Authorizationstring

Bearer token for authentication (admin required)

Request Body

User details

emailstring
role?string

Response Body

curl -X POST "https://loading/api/v0/users" \
  -H "Authorization: string" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "string"
  }'
{}
{
  "property1": "string",
  "property2": "string"
}
{
  "property1": "string",
  "property2": "string"
}
{
  "property1": "string",
  "property2": "string"
}
{
  "property1": "string",
  "property2": "string"
}

Update a user (admin only)

Update a user's email or role

PATCH
/users/{id}

Path Parameters

idstring

User ID

Header Parameters

Authorizationstring

Bearer token for authentication (admin required)

Request Body

User update details

email?string
role?string

Response Body

curl -X PATCH "https://loading/api/v0/users/string" \
  -H "Authorization: string" \
  -H "Content-Type: application/json" \
  -d '{}'
{}
{
  "property1": "string",
  "property2": "string"
}
{
  "property1": "string",
  "property2": "string"
}
{
  "property1": "string",
  "property2": "string"
}
{
  "property1": "string",
  "property2": "string"
}
{
  "property1": "string",
  "property2": "string"
}

Delete a user (admin only)

Delete a user by ID

DELETE
/users/{id}

Path Parameters

idstring

User ID

Header Parameters

Authorizationstring

Bearer token for authentication (admin required)

Response Body

curl -X DELETE "https://loading/api/v0/users/string" \
  -H "Authorization: string"
{
  "property1": "string",
  "property2": "string"
}
{
  "property1": "string",
  "property2": "string"
}
{
  "property1": "string",
  "property2": "string"
}
{
  "property1": "string",
  "property2": "string"
}
{
  "property1": "string",
  "property2": "string"
}