Schedules

Get schedule recipients

get/api/v1/schedules/{scheduleId}/recipients

Request

Base URL
https://omniapp.co (the document declares no server; this is the origin it was published from)
URL
https://omniapp.co/api/v1/schedules/{scheduleId}/recipients
Auth
HTTP bearer

Path parameters

scheduleIdstring uuid required

The UUID of the scheduled task. Can be found in the schedule's URL after /schedules/.

Example:123e4567-e89b-12d3-a456-426614174000

Response

Schedule recipients

type'email' | 'google_sheets' | 's3' | 'sftp' | 'slack' | 'webhook' required

The schedule's destination type.

Example response

{
  "recipients": [
    {
      "email": "user@example.com",
      "name": "John Doe"
    }
  ],
  "type": "email",
  "userGroupRecipients": [
    {
      "id": "X9kQ2mPz",
      "name": "Sales Team",
      "recipients": [
        {
          "email": "user@example.com",
          "name": "John Doe"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 97 revisions of this API.