Invites

Download schema

Invites to join the team, sent by email. The invitee accepts in the dashboard, signed in with that address, and gets the invite's role. Invites expire after 7 days. Pending invites count towards the plan's member limit.

List invites

GET

https://api.spectate.net/v1

/invites

Returns the team's invites that weren't accepted or revoked, newest first, including expired ones.

List invites › query Parameters

page

integer

Page number, from 1.

Default: 1

per_page

integer

Invites per page, 1 to 100.

Default: 25

List invites › Responses

Paginated set of Invite

current_page

integer · min: 1 · required

Invite[] · 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.

Invite someone

POST

https://api.spectate.net/v1

/invites

Emails them a link to join the team. Someone who is a member already, or has a pending invite, can't be invited again (422); an expired invite to the address is replaced. Over the plan's member limit, counting pending invites, the request fails with 403 PLAN_LIMIT_REACHED.

Invite someone › Request Body

Someone to invite to the team.

CreateInvite

email

string · email · maxLength: 255 · required

Their email address; disposable addresses aren't accepted

Example: jane@example.com

role

TeamRole · enum

The role they get when they accept (default member); owner can't be given


`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

Invite someone › Responses

The invite.

An invite to join the team, sent by email. The invitee accepts it in the dashboard with an account for that address.

Invite

id

string · uuid · required

Invite ID

email

string · email · required

The invitee's email address

Example: jane@example.com

role

TeamRole · enum · required

The role they get when they accept


`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

expired

boolean · required

Whether it expired without being accepted. Expired invites don't count towards the member limit and can be sent again

expires_at

string · date-time · required

When it expires, 7 days after it was sent

created_at

string · date-time · required

When it was sent

Get an invite

GET

https://api.spectate.net/v1

/invites/{invite}

Returns the invite, also when it has expired.

Get an invite › path Parameters

invite

string · uuid · required

Invite ID.

Get an invite › Responses

The invite.

An invite to join the team, sent by email. The invitee accepts it in the dashboard with an account for that address.

Invite

id

string · uuid · required

Invite ID

email

string · email · required

The invitee's email address

Example: jane@example.com

role

TeamRole · enum · required

The role they get when they accept


`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

expired

boolean · required

Whether it expired without being accepted. Expired invites don't count towards the member limit and can be sent again

expires_at

string · date-time · required

When it expires, 7 days after it was sent

created_at

string · date-time · required

When it was sent

Revoke an invite

DELETE

https://api.spectate.net/v1

/invites/{invite}

The link in the email stops working. The invitee isn't told.

Revoke an invite › path Parameters

invite

string · uuid · required

Invite ID.

Revoke an invite › Responses

No content

No data returned

Members Billing