Spectate
Spectate API
Spectate API

Team

Download schema

The team the API token belongs to: its name, time zone, plan and whether monitoring runs. Deleting the team and changing billing happen in the dashboard.

Get the team

GET
https://api.spectate.net/v1
/team

Returns the token's team. Works with any token.

Get the team › Responses

The team.

The team the API token belongs to.
Team
id
​string · uuid · required

Team ID

name
​string · required

Name

Example: Acme
email
​string | null · email · required

The team's billing email: Spectate gives it to Vatly, which sends the invoices and receipts, at the team's first checkout (a plan or credits). null to use the address of the member who starts that checkout

Example: ops@acme.com
timezone
​string · required

The team's time zone; escalation path working hours without a time zone of their own use it

Example: Europe/Amsterdam
plan
​Plan · enum · required

The plan whose limits apply now: the trial plan during the trial

none
No paid plan and no trial: monitoring is paused until the team subscribes.
starter
Starter: up to 3 members and 1 status page, the team default escalation path only.
team
Team: unlimited members, 5 status pages, on-call, more escalation paths and private status pages.
business
Business: everything in Team, with unlimited status pages and more subscribers and notification credits.
Enum values:
none
starter
team
business
on_trial
​boolean · required

Whether the team is on its trial, without a paid plan yet

trial_ends_at
​string | null · date-time · required

When the trial ends; null without one

monitoring_paused_at
​string | null · date-time · required

Since when all monitoring is paused; null while it runs

​required
deletion_scheduled_at
​string | null · date-time · required

When the team and all its data will be deleted; null when it isn't scheduled. An owner can cancel it in the dashboard

​required
created_at
​string · date-time · required

When the team was created

Update the team

PATCH
https://api.spectate.net/v1
/team

Changes only the fields you send.

Update the team › Request Body

Changes to the team; fields left out keep their value.
UpdateTeam
name
​string · maxLength: 255

Name, up to 255 characters

Example: Acme
email
​string | null · email · maxLength: 255

The team's billing email: Spectate gives it to Vatly, which sends the invoices and receipts, at the team's first checkout (a plan or credits). null to use the address of the member who starts that checkout

Example: ops@acme.com
timezone
​string

The team's time zone, as an IANA name; escalation path working hours without a time zone of their own use it

Example: Europe/Amsterdam

Update the team › Responses

The updated team.

The team the API token belongs to.
Team
id
​string · uuid · required

Team ID

name
​string · required

Name

Example: Acme
email
​string | null · email · required

The team's billing email: Spectate gives it to Vatly, which sends the invoices and receipts, at the team's first checkout (a plan or credits). null to use the address of the member who starts that checkout

Example: ops@acme.com
timezone
​string · required

The team's time zone; escalation path working hours without a time zone of their own use it

Example: Europe/Amsterdam
plan
​Plan · enum · required

The plan whose limits apply now: the trial plan during the trial

none
No paid plan and no trial: monitoring is paused until the team subscribes.
starter
Starter: up to 3 members and 1 status page, the team default escalation path only.
team
Team: unlimited members, 5 status pages, on-call, more escalation paths and private status pages.
business
Business: everything in Team, with unlimited status pages and more subscribers and notification credits.
Enum values:
none
starter
team
business
on_trial
​boolean · required

Whether the team is on its trial, without a paid plan yet

trial_ends_at
​string | null · date-time · required

When the trial ends; null without one

monitoring_paused_at
​string | null · date-time · required

Since when all monitoring is paused; null while it runs

​required
deletion_scheduled_at
​string | null · date-time · required

When the team and all its data will be deleted; null when it isn't scheduled. An owner can cancel it in the dashboard

​required
created_at
​string · date-time · required

When the team was created

Status page issue reportsMembers