List On-Call Roles

GET

on_call_roles

List On-Call Roles

curl --request GET \
  --url https://api.rootly.com/v1/on_call_roles \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "type": "on_call_roles",
      "attributes": {
        "name": "<string>",
        "slug": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "system_role": "custom",
        "alert_sources_permissions": [
          "create"
        ],
        "alert_urgency_permissions": [
          "create"
        ],
        "alerts_permissions": [
          "create"
        ],
        "api_keys_permissions": [
          "create"
        ],
        "audits_permissions": [
          "create"
        ],
        "contacts_permissions": [
          "read"
        ],
        "escalation_policies_permissions": [
          "create"
        ],
        "groups_permissions": [
          "create"
        ],
        "heartbeats_permissions": [
          "create"
        ],
        "integrations_permissions": [
          "create"
        ],
        "invitations_permissions": [
          "create"
        ],
        "live_call_routing_permissions": [
          "create"
        ],
        "schedule_override_permissions": [
          "create"
        ],
        "schedules_permissions": [
          "create"
        ],
        "services_permissions": [
          "create"
        ],
        "webhooks_permissions": [
          "create"
        ],
        "workflows_permissions": [
          "create"
        ]
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

include

string

page[number]

integer

page[size]

integer

filter[search]

string

filter[slug]

string

filter[name]

string

filter[created_at][gt]

string

filter[created_at][gte]

string

filter[created_at][lt]

string

filter[created_at][lte]

string

sort

string

Response

200 - application/vnd.api+json

success

data

object[]

required

Show child attributes

data.id

string

required

Unique ID of the on_call_role

data.type

enum<string>

required

Available options:

on_call_roles

data.attributes

object

required

Show child attributes

data.attributes.name

string

required

The role name.

data.attributes.slug

string

required

The role slug.

data.attributes.created_at

string

required

data.attributes.updated_at

string

required

data.attributes.system_role

string

default:custom

The kind of role

data.attributes.alert_sources_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.alert_urgency_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.alerts_permissions

enum<string>[]

Available options:

create,

update,

read

data.attributes.api_keys_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.audits_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.contacts_permissions

enum<string>[]

Available options:

read

data.attributes.escalation_policies_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.groups_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.heartbeats_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.integrations_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.invitations_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.live_call_routing_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.schedule_override_permissions

enum<string>[]

Available options:

create,

update

data.attributes.schedules_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.services_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.webhooks_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

data.attributes.workflows_permissions

enum<string>[]

Available options:

create,

read,

update,

delete

links

object

required

Show child attributes

links.self

string

required

links.first

string

required

links.prev

string | null

required

links.next

string | null

required

links.last

string

required

Creates an On-Call RoleCreates a new On-Call Role from provided data

⌘I

List On-Call Roles

curl --request GET \
  --url https://api.rootly.com/v1/on_call_roles \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "id": "<string>",
      "type": "on_call_roles",
      "attributes": {
        "name": "<string>",
        "slug": "<string>",
        "created_at": "<string>",
        "updated_at": "<string>",
        "system_role": "custom",
        "alert_sources_permissions": [
          "create"
        ],
        "alert_urgency_permissions": [
          "create"
        ],
        "alerts_permissions": [
          "create"
        ],
        "api_keys_permissions": [
          "create"
        ],
        "audits_permissions": [
          "create"
        ],
        "contacts_permissions": [
          "read"
        ],
        "escalation_policies_permissions": [
          "create"
        ],
        "groups_permissions": [
          "create"
        ],
        "heartbeats_permissions": [
          "create"
        ],
        "integrations_permissions": [
          "create"
        ],
        "invitations_permissions": [
          "create"
        ],
        "live_call_routing_permissions": [
          "create"
        ],
        "schedule_override_permissions": [
          "create"
        ],
        "schedules_permissions": [
          "create"
        ],
        "services_permissions": [
          "create"
        ],
        "webhooks_permissions": [
          "create"
        ],
        "workflows_permissions": [
          "create"
        ]
      }
    }
  ],
  "links": {
    "self": "<string>",
    "first": "<string>",
    "prev": "<string>",
    "next": "<string>",
    "last": "<string>"
  }
}

Overview

AlertEvents

AlertFields

AlertGroups

AlertRoutes

AlertRoutingRules

AlertUrgencies

AlertSources

Alerts

Audits

Authorizations

CatalogEntities

CatalogEntityProperties

CatalogFields

Catalogs

Causes

Communications Groups

Communications Stages

Communications Templates

Communications Types

[DEPRECATED] CustomFieldOptions

[DEPRECATED] CustomFields

CustomForms

DashboardPanels

Dashboards

Environments

EscalationPolicies

EscalationLevelsPolicies

EscalationLevelsPath

EscalationLevels

EscalationPaths

FormFieldOptions

FormFieldPlacementConditions

FormFieldPlacements

FormFieldPositions

FormFields

FormSetConditions

FormSets

Functionalities

WorkflowTasks

[DEPRECATED] WorkflowCustomFieldSelections

WorkflowFormFieldConditions

WorkflowGroups

WorkflowRuns

Workflows

Heartbeats

IncidentActionItems

[DEPRECATED] IncidentCustomFieldSelections

IncidentEventFunctionalities

IncidentEventServices

IncidentEvents

IncidentFeedbacks

IncidentFormFieldSelections

IncidentPermissionSetBooleans

IncidentPermissionSetResources

IncidentPermissionSets

IncidentRetrospectives

IncidentRetrospectiveSteps

IncidentRoleTasks

IncidentRoles

IncidentStatusPageEvents

IncidentSubStatuses

IncidentTypes

Incidents

IpRanges

LiveCallRouters

OnCallRoles

OnCallShadows

OverrideShifts

PlaybookTasks

Playbooks

RetrospectiveTemplates

Pulses

RetrospectiveConfigurations

RetrospectiveProcessGroupSteps

RetrospectiveProcessGroups

RetrospectiveProcesses

RetrospectiveSteps

Roles

ScheduleRotationActiveDays