Team

Get the team

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

get/team

Request

  • Base URL
    https://api.spectate.net/v1
  • Auth
    HTTP bearer

Response

The team.

idstring uuid required

Team ID

namestring required

Name

emailstring email nullable 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

timezonestring required

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

plan'none' | 'starter' | 'team' | 'business' required

Billing plans (docs/billing.md). The plan sets the features; the number of monitors + hosts is the subscription's quantity, priced per monitor (config/billing.php). None is a team without a paid plan: on the trial (which uses the trial plan's limits) or unpaid (paused).

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

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

trial_ends_atstring date-time nullable required

When the trial ends; null without one

monitoring_paused_atstring date-time nullable required

Since when all monitoring is paused; null while it runs

monitoring_paused_reason'unpaid' | 'deletion_scheduled' | 'staff' required
unpaid <br/> No paid plan: the trial or the subscription ended. Resumes when the team subscribes.
deletion_scheduled <br/> The team is scheduled for deletion.
staff <br/> Paused by Spectate staff from Overwatch (abuse, payment issues, on request).
deletion_scheduled_atstring date-time nullable 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

deletion_reason'requested' | 'unpaid' required
requested <br/> An owner deleted the team.
unpaid <br/> Monitoring was paused for too long without a paid plan (team_lifecycle.unpaid).
created_atstring date-time required

When the team was created

Example response

{
  "name": "Acme",
  "email": "ops@acme.com",
  "timezone": "Europe/Amsterdam"
}

Changes

No recorded changes to this operation across all 1 revision of this API.