Supported operations
| Method | Path | Description |
|---|---|---|
| GET | /api/v1/users | List all users in tenant |
| GET | /api/v1/users/:id | Get a user by ID |
Example request
Replace YOUR_API_KEY with a private key stored in your environment. Replace path parameters with records from your organization.
curl --request GET "/api/v1/users" \
--header "Authorization: Bearer YOUR_API_KEY" \
--header "Accept: application/json"
Field reference
Required means required by the underlying data model, not necessarily caller-supplied. The server derives protected identity and ownership fields; endpoint validation controls which fields are accepted. Sensitive credential fields are omitted here.
| Field | Type | Model requirement | Description |
|---|---|---|---|
id | string | Optional | Unique identifier (auto-generated) |
displayName | string | Required | username |
email | string | Required | |
role | enum | Optional | role Values: |
defaultTeam | enum | Optional | default Team Values: |
createdAt | datetime | Optional | Creation timestamp (auto) |