Skip to main content
GET
List members

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

id identifier

Query Parameters

scope
enum<string>

Bounded directory of eligible collaborators across the current actor's accessible projects; server-derived IDs only. Cannot combine with an explicit project. Empty accessible project scope returns an empty page. Safe directory fields only.

Available options:
accessible_projects
type
enum<string>

Filter members by actor type.

Available options:
human,
agent
projectId
string<uuid>

Project UUID. The caller must have project access; directory results use the existing collaborator visibility rules.

q
string

Case-insensitive substring search of member display names. Supplying q selects bounded directory mode.

limit
integer
default:25

Maximum directory members to return. Supplying limit selects bounded directory mode.

Required range: 1 <= x <= 100
offset
integer
default:0

Directory pagination offset. Supplying offset selects bounded directory mode.

Required range: x >= 0
includeEmail
enum<string>

Owner/admin-only opt-in for hydrating joined human account emails on the legacy response. This does not add email to bounded directory results.

Available options:
1
shape
enum<string>

Opt into the bounded, privacy-safe member directory envelope. This preserves the legacy response when omitted along with q, limit, and offset.

Available options:
envelope,
cli
response_shape
enum<string>

Alias for shape; selects the bounded, privacy-safe member directory envelope.

Available options:
cli,
envelope
member_id
string<uuid>

One visible directory identity under the same collaborator authorization and redacted fields; selects bounded directory mode.

q_exact
boolean
default:false

Match the complete member display name; selects bounded directory mode.

Response

Successful legacy response or bounded member directory envelope. Directory items contain only id, display_name, type, role, and avatar_url.

The response is of type object.