Skip to main content
GET
List team members
In the Heliyos MCP server: heliyos_team_members_list.

Authorizations

Authorization
string
header
required

A workspace API key, sent as Authorization: Bearer heliyos_.... Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in.

Query Parameters

Text to match, case-insensitive and literally, in the email address, first name or last name. Up to 200 characters. Empty matches everyone.

Maximum string length: 200
page
integer
default:1

The page number, starting at 1. Defaults to 1.

Required range: x >= 1
pageSize
integer
default:20

Memberships per page, 1 to 100. Defaults to 20.

Required range: 1 <= x <= 100
roleName
enum<string>

Only memberships with this role. Workspace roles are OWNER, ADMIN and MEMBER, plus AGENCY in an agency workspace. The other accepted values are Heliyos staff roles and match no one in a workspace. Empty means every role.

Available options:
ADMIN,
OWNER,
MEMBER,
AGENCY,
SUPER_ADMIN,
STAFF,
SUPPORT,

Response

A page of memberships.

meta
object
required
data
object[]
required