API Field in List users on call

Question

Looking to use the API to determine who is on-call and the mandatory field is simply ‘id’. The description of the field is incredibly vague.

id (string) required

The ID of the resource.

Where do I find this ‘id’ field? I have tried the URL ID from the service, policy & escalation policy id’s but nothing is working.

lupimiguel · Accepted Answer

Hi ​@Scott R,The “id” field required by the List users on call API is actually the Schedule ID. This endpoint is designed to return the users who are on call for a specific schedule, so you need to provide the ID of the schedule you want to query.Where you can find the Schedule ID:In the PagerDuty web UI, go to the “Schedules” section.Click on the schedule you want.The Schedule ID is in the URL, right after /schedules/. For example, if your URL is https://[yourdomain].pagerduty.com/schedules/PABC123, then PABC123 is your Schedule ID.Use this Schedule ID as the “id” parameter in your API call.Please let me know if it works and have a nice day!

Scott R · Answer

Hi ​@Scott R,The “id” field required by the List users on call API is actually the Schedule ID. This endpoint is designed to return the users who are on call for a specific schedule, so you need to provide the ID of the schedule you want to query.Where you can find the Schedule ID:In the PagerDuty web UI, go to the “Schedules” section.Click on the schedule you want.The Schedule ID is in the URL, right after /schedules/. For example, if your URL is https://[yourdomain].pagerduty.com/schedules/PABC123, then PABC123 is your Schedule ID.Use this Schedule ID as the “id” parameter in your API call.Please let me know if it works and have a nice day!Thank you this worked, but Ithought I had tried that.. I would hope Pagerduty would refine their documentation..

PagerDuty x Backstage Meetup: Developer Experience, Automated

Join PagerDuty Commons

Login to PagerDuty Commons

Scanning file for viruses.

This file cannot be downloaded