Skip to main content
GET
/
v1
/
schedules
/
{scheduleId}
/
recipients
List schedule recipients
curl --request GET \
  --url https://{instance}.omniapp.co/api/v1/schedules/{scheduleId}/recipients \
  --header 'Authorization: Bearer <token>'
{
  "recipients": [
    {
      "email": "blobby@blobsrus.com",
      "emailOnly": false,
      "id": "3e7c4152-cdac-42ce-8749-fe3b81d5d8ab",
      "name": "blobby@blobsrus.com"
    }
  ],
  "type": "email"
}

Authorizations

​
Authorization
string
header
required

Can be either an Organization API Key or Personal Access Token (PAT).

Include in the Authorization header as: Bearer YOUR_TOKEN

Path Parameters

​
scheduleId
string<uuid>
required

The ID of the schedule. To find a schedule's ID:

  1. Navigate to the dashboard of a document.
  2. Click File > Deliveries & Alerts.
  3. Next to a schedule, click Edit.

The schedule's ID is in the page's URL, after /schedules/. For example, the schedule ID in this URL is 123e4567-e89b-12d3-a456-426614174000:

https://blobsrus.omniapp.co/dashboards/e23ebaa0/schedules/123e4567-e89b-12d3-a456-426614174000

Response

Successful requests return a 200 OK status and response body specific to the schedule's destination type.

Response for schedules with email destinations.

​
type
enum<string>

The destination type.

Available options:
email
​
recipients
object[]