Need help? Get answers from the docs with Omni's in-app AI! Log in to your Omni instance and open the Omni Agent in the sidebar.
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"
}List schedule recipients
Retrieves the list of recipients for the specified schedule. Successful responses will include the recipients and details about the schedule’s destination type.
To retrieve a schedule’s full configuration, use the List schedules endpoint.
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"
}Documentation Index
Fetch the complete documentation index at: https://docs.omni.co/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Can be either an Organization API Key or Personal Access Token (PAT).
Include in the Authorization header as: Bearer YOUR_TOKEN
Path Parameters
The ID of the schedule. To find a schedule's ID:
- Navigate to the dashboard of a document.
- Click File > Deliveries & Alerts.
- 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-426614174000Response
Successful requests return a 200 OK status and response body specific to the schedule's destination type.
Was this page helpful?