Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Account

List members

The people who can reach the workspace, oldest first, each with its role here: the organization's owners and admins, and the members invited into it.

get/api/v1/members

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy members list
MCP tooltroopy_list_members
Rate limit120 calls in 60 seconds, for each key

Query parameters

pageinteger

1-based page number

Default 1 · At least 1

limitinteger

Items per page, at most 100

Default 20 · At least 1 · At most 100

Response

200 · application/json
data*array<object>
5 properties
id*string

A 24-character id

name*string
email*string
role*enum<string>

Role in the workspace. Owners and admins of the organization reach every workspace. Each other person has its own role in each workspace that it is in: admin (of that workspace only), member, approver, viewer or guest. An approver reads the workspace, and decides what waits on people. A viewer reads it, and changes nothing. A guest reads only the products that someone picked for it, and comments on them

owneradminmemberapproverviewerguest

joinedAt*string

ISO 8601 date and time

pagination*object
4 properties
page*integer
limit*integer
total*integer
pages*integer

Errors

400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
429 rate_limitedWait the number of seconds in Retry-After, then retry.