Skip to main content
GET
List members

Authorizations

Authorization
string
header
required

Your API key, sent bare. See Authentication.

Query Parameters

workspace_id
string
required

Workspace ID, beginning with wks_. Treat it as an opaque string. Integer workspace ids are still accepted.

Example:

"wks_01k6a2r9s8x7c2dvq3m5n6p4ab"

email
string<email>

Only the member with this email (case-insensitive).

limit
integer
default:25

Page size, 1 to 100.

Required range: 1 <= x <= 100
cursor
string

Opaque. Follow _links.next.url rather than building it.

include
enum<string>

settings adds each object's settings block.

Available options:
settings

Response

One page of members.

object
string

Always list.

data
object[]

The members on this page.

has_more
boolean

Whether more results follow this page.

Empty on the last page.