Skip to content
BuildWorkPro Docs

List users

GET
/users

Returns a cursor-paginated list of tenant team members (name, email, role).

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
limit
integer
>= 1 <= 100
cursor
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Users page

object
data
required
Array<object>
object
id
required
integer
tenantUserId
required
integer
firstName
required
string | null
lastName
required
string | null
email
required
string | null
username
required
string
role
required
string
isActive
required
boolean
joinedAt
required
Any of:
string format: date-time
meta
required
object
request_id

Server-generated request identifier

string
pagination
object
cursor
required

Opaque cursor for the next page; null when no more results

string | null
has_more
required

Whether more pages are available after this one

boolean
count
required

Items in this page

integer

403

Section titled “403 ”

Error

object
type
required

URL identifying the problem type

string format: uri
title
required

Short human-readable summary

string
status
required

HTTP status code

integer
detail

Human-readable explanation

string
request_id

Server-generated request identifier

string
errors

Validation error array (422 only)

Array<object>
object
field
required

Field path that failed validation

string
code
required

Validation error code

string
message
required

Human-readable validation message

string