Comment on page

Teams

​Teams represent a group of account users. Every team has one active schedule and one active escalation policy.
The Team Object
Property
Type
Description
name
string
The name of the team
escalation_policy_id
string
The ID of the active escalation policy for this team.
schedule_id
string
The ID of the active schedule for this team.
member_account_user_ids
string[]
IDs of account users the take on the member role for this team.
admin_account_user_ids
string[]
IDs of the account users that take on the admin role for this team.
drop_notifications
string
none|team_all|team_admins|oncall_rotation|specific_users
handoff_notifications
string
none|team_all|team_admins|oncall_rotation|specific_users
drop_notification_account_user_ids
string[]
If drop_notifications set to specific_users, the account user IDs to send drop notifications to.
handoff_notification_account_user_ids
string[]
If handoff_notifications set to specific_users, the account user IDs to send drop notifications to.
notes
string
Notes to be displayed for this team.
attachments
hash
:filename, :url
Create a Team
POST https://api.pagertree.com/api/v4/teams
Allowed Parameters
def team_params
  params.permit(
    :meta,
    :name,
    :notes,
    :drop_notifications,
    :handoff_notifications,
    member_account_user_ids: [],
    admin_account_user_ids: [],
    drop_notification_account_user_ids: [],
    handoff_notification_account_user_ids: []
  )
end
Required Parameters
name
at least 1 account user as a member role​
at least 1 account user as an admin role​
A default schedule and escalation policy will be created by PagerTree.
Retrieve a Team
GET https://api.pagertree.com/api/v4/teams/:id
Update a Team
PUT https://api.pagertree.com/api/v4/teams/:id
Delete a Team
DELETE https://api.pagertree.com/api/v4/teams/:id
List all Teams
GET https://api.pagertree.com/api/v4/teams
Current On-Call
Returns on-call event attendees for now for this team. (Handles repeating events and rotations)
Shortcut for schedule current on-call method.
GET https://api.pagertree.com/api/v4/teams/:id/current_oncall
List a Team's Alerts
Return alerts that have been assigned to this team.
GET https://api.pagertree.com/api/v4/teams/:id/alerts

Property	Type	Description
name	string	The name of the team
escalation_policy_id	string	The ID of the active escalation policy for this team.
schedule_id	string	The ID of the active schedule for this team.
member_account_user_ids	string[]	IDs of account users the take on the member role for this team.
admin_account_user_ids	string[]	IDs of the account users that take on the admin role for this team.
drop_notifications	string	`none\|team_all\|team_admins\|oncall_rotation\|specific_users`
handoff_notifications	string	`none\|team_all\|team_admins\|oncall_rotation\|specific_users`
drop_notification_account_user_ids	string[]	If drop_notifications set to `specific_users`, the account user IDs to send drop notifications to.
handoff_notification_account_user_ids	string[]	If handoff_notifications set to `specific_users`, the account user IDs to send drop notifications to.
notes	string	Notes to be displayed for this team.
attachments	hash	:filename, :url

API - Previous

Schedules

Next - API

Users

Last modified 11mo ago