Members

Download schema

The people in the team and their roles. Members join by accepting an invite. Use member IDs in on-call rotations and incident roles.

List members

GET

https://api.spectate.net/v1

/members

Returns the team's members, by name.

List members › query Parameters

filter[role]

TeamRole · enum

Only members with this role.

A member's role in the team: what they may do.


`owner` Everything, including billing and deleting the team. One per team.
`manager` Everything but billing and deleting the team.
`admin` Configure monitoring, alerting, incidents and status pages; can't manage members or API tokens.
`member` Read everything; manage monitors and incidents, acknowledge alerts.
`billing` Billing and support only.

Enum values:

owner

manager

admin

member

billing

page

integer

Page number, from 1.

Default: 1

per_page

integer

Members per page, 1 to 100.

Default: 25

List members › Responses

Paginated set of Member

current_page

integer · min: 1 · required

Member[] · required

first_page_url

string | null · required

from

integer | null · min: 1 · required

last_page_url

string | null · required

last_page

integer · min: 1 · required

object[] · required

Generated paginator links.

next_page_url

string | null · required

path

string | null · required

Base path for paginator generated URLs.

per_page

integer · min: 0 · required

Number of items shown per page.

prev_page_url

string | null · required

to

integer | null · min: 1 · required

Number of the last item in the slice.

total

integer · min: 0 · required

Total number of items being paginated.

Get a member

GET

https://api.spectate.net/v1

/members/{member}

Returns a member of the team by their ID.

Get a member › path Parameters

member

string · uuid · required

Member (user) ID.

Get a member › Responses

The member.

A member of the team. Use member IDs for on-call rotations and incident roles.

Member

id

string · uuid · required

Member (user) ID

name

string · required

Name

Example: Jane Doe

email

string · email · required

Email address

Example: jane@example.com

role

TeamRole · enum · required

Role in the team


`owner` Everything, including billing and deleting the team. One per team.
`manager` Everything but billing and deleting the team.
`admin` Configure monitoring, alerting, incidents and status pages; can't manage members or API tokens.
`member` Read everything; manage monitors and incidents, acknowledge alerts.
`billing` Billing and support only.

Enum values:

owner

manager

admin

member

billing

joined_at

string | null · date-time · required

When they joined the team

Change a member's role

PATCH

https://api.spectate.net/v1

/members/{member}

The owner's role can't change, and nobody becomes owner this way (403 TEAM_OWNER_PROTECTED). The API can't transfer ownership: only the owner can, in the dashboard (Team → Settings), after confirming their password.

Change a member's role › path Parameters

member

string · uuid · required

Member (user) ID.

Change a member's role › Request Body

A member's new role.

UpdateMember

role

TeamRole · enum · required

The role; owner can't be given (422)


`owner` Everything, including billing and deleting the team. One per team.
`manager` Everything but billing and deleting the team.
`admin` Configure monitoring, alerting, incidents and status pages; can't manage members or API tokens.
`member` Read everything; manage monitors and incidents, acknowledge alerts.
`billing` Billing and support only.

Enum values:

owner

manager

admin

member

billing

Change a member's role › Responses

The member with the new role.

A member of the team. Use member IDs for on-call rotations and incident roles.

Member

id

string · uuid · required

Member (user) ID

name

string · required

Name

Example: Jane Doe

email

string · email · required

Email address

Example: jane@example.com

role

TeamRole · enum · required

Role in the team


`owner` Everything, including billing and deleting the team. One per team.
`manager` Everything but billing and deleting the team.
`admin` Configure monitoring, alerting, incidents and status pages; can't manage members or API tokens.
`member` Read everything; manage monitors and incidents, acknowledge alerts.
`billing` Billing and support only.

Enum values:

owner

manager

admin

member

billing

joined_at

string | null · date-time · required

When they joined the team

Remove a member

DELETE

https://api.spectate.net/v1

/members/{member}

They lose access to the team at once and leave its on-call rotations; what they did stays in the history. API tokens they created keep working: revoke them in the dashboard if needed. The owner can't be removed (403 TEAM_OWNER_PROTECTED).

Remove a member › path Parameters

member

string · uuid · required

Member (user) ID.

Remove a member › Responses

No content

No data returned

Team Invites