Skip to main content
Lists the members of your team. Any member may read the roster; contact details (email, username) are returned only to owners and admins.
Permission required: none — any member’s key can call this
  • When you set email: team owner or admin

Query Parameters

integer
default:"20"
Number of items per page (1–100)
string
Token from the previous page. Opaque — do not construct or parse it.
string
Case-insensitive substring match on the member’s display name. For team owners and admins it also matches email and username.
string
Only members whose role field is this role key (tenant_owner, tenant_admin, tenant_member or a custom role key). An unknown key matches nobody.
array
Only members with these email addresses (case-insensitive, exact). Repeat the parameter for several. Contact details are visible only to owners and admins, so this filter is too: anyone else gets 403.
string
Only human members or only virtual members

Response

object

Errors

Errors answer with success: false, a message and an error_code. See Error Codes for every code.