Skip to content
Vocapable Developers

The tenant's user directory (read-only)

GET
/v1/users
curl --request GET \
  --url 'https://api.vocapable.com/v1/users?limit=50' \
  --header 'Authorization: Bearer <token>'

Who work can be attributed or assigned to - never a management surface.

Invitations, role changes, and deactivation have no /v1 route on purpose; this exists so the portal can render an assignee picker and resolve “assign to me” (ADR-0037) without holding anything wider than a read.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
limit
Limit
integer
default: 50 >= 1 <= 200
cursor
Any of:
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CursorPage[TenantUserSummary]
object
data
required
Data
Array<object>
TenantUserSummary

One row of the read-only tenant user directory (GET /v1/users).

Deliberately narrow: enough to render an assignee picker and attribute work, never a management surface - there is no invitation, role, or status write on /v1.

object
id
required
Id
string
email
required
Email
string
role
required
Role
string
status
required
Status
string
created_at
required
Created At
string format: date-time
next_cursor
Any of:
string
has_more
Has More
boolean
Example
{
  "has_more": false
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}