List Members - Tomorro API

Returns a paginated list of members in your organization. Supports cursor-based pagination, sorting, and filtering.

Query Parameters

Pagination

Parameter	Type	Default	Description
`page[size]`	integer	20	Items per page (1-50)
`after`	string	-	Cursor for next page
`before`	string	-	Cursor for previous page

Sorting

Parameter	Type	Default	Description
`sort`	string	`-createdAt`	Sort order. Prefix with `-` for descending

Allowed sort fields: id, role, status, createdAt, updatedAt

Filtering

Parameter	Description
`filter[status]`	Filter by exact status
`filter[status][eq]`	Status equals
`filter[status][ne]`	Status not equals
`filter[status][in]`	Status in list (comma-separated)
`filter[role]`	Filter by exact role
`filter[role][eq]`	Role equals
`filter[role][ne]`	Role not equals
`filter[role][in]`	Role in list (comma-separated)

Other

Parameter	Type	Default	Description
`includeDisabled`	boolean	`true`	Include disabled members

Examples

Get active admins

GET /members?filter[status]=active&filter[role]=admin

Paginate through results

# First page
GET /members?page[size]=10

# Next page (use nextCursor from response)
GET /members?page[size]=10&after=eyJpZCI6IjEyMyJ9

Sort by role, then creation date

GET /members?sort=role,-createdAt

Filter multiple statuses

GET /members?filter[status][in]=active,pending

Authorizations

x-api-key

string

header

required

Your Tomorro API key. You can generate one from your organization settings.

Query Parameters

page[size]

integer

default:20

Number of items per page (1-50)

Required range: 1 <= x <= 50

after

string

Cursor for fetching items after this position (for forward pagination)

before

string

Cursor for fetching items before this position (for backward pagination)

sort

string

default:-createdAt

Sort order. Comma-separated list of fields. Prefix with - for descending. Allowed fields: id, role, status, createdAt, updatedAt

includeDisabled

boolean

default:true

Include disabled members in results

filter[status]

enum<string>

Filter by status (exact match) The current status of the member

Available options:

active,

disabled,

pending

filter[status][eq]

enum<string>

Filter by status equals The current status of the member

Available options:

active,

disabled,

pending

filter[status][ne]

enum<string>

Filter by status not equals The current status of the member

Available options:

active,

disabled,

pending

filter[status][in]

string

Filter by status in list (comma-separated)

filter[role]

enum<string>

Filter by role (exact match) The role of the member within the organization

Available options:

user,

manager,

admin

filter[role][eq]

enum<string>

Filter by role equals The role of the member within the organization

Available options:

user,

manager,

admin

filter[role][ne]

enum<string>

Filter by role not equals The role of the member within the organization

Available options:

user,

manager,

admin

filter[role][in]

string

Filter by role in list (comma-separated)

Response

List of members

Paginated list of members

data

object[]

required

Show child attributes

data.id

string<uuid>

required

Unique identifier of the member

data.user

object

required

User account information

Show child attributes

data.user.id

string<uuid>

required

Unique identifier of the user

data.user.username

string<email>

required

Email address of the user

data.user.firstname

string | null

First name of the user

data.user.lastname

string | null

Last name of the user

data.role

enum<string>

required

The role of the member within the organization

Available options:

user,

manager,

admin

data.status

enum<string>

required

The current status of the member

Available options:

active,

disabled,

pending

data.contracts

object[]

required

List of contracts associated with this member

Show child attributes

data.contracts.id

string<uuid>

required

Unique identifier of the contract

data.contracts.title

string

required

Title of the contract

data.contracts.role

enum<string>

required

The member's role in this contract

Available options:

creator,

participant

data.contracts.status

string | null

Current status of the contract

data.createdAt

string<date-time>

When the member was created

data.updatedAt

string<date-time>

When the member was last updated

pagination

object

required

Show child attributes

pagination.hasNext

boolean

required

Whether there are more items after this page

pagination.hasPrevious

boolean

required

Whether there are items before this page

pagination.nextCursor

string | null

Cursor to use for fetching the next page

pagination.previousCursor

string | null

Cursor to use for fetching the previous page

Overview

Members

​Query Parameters

​Pagination

​Sorting

​Filtering

​Other

​Examples

​Get active admins

​Paginate through results

​Sort by role, then creation date

​Filter multiple statuses

Authorizations

Query Parameters

Response

Query Parameters

Pagination

Sorting

Filtering

Other

Examples

Get active admins

Paginate through results

Sort by role, then creation date

Filter multiple statuses