schedules

Org Schedules List Post

POST
Gets list of organization schedules.

Request

This endpoint expects an object.
created_by_id
list of stringsOptional
Creator ID the filter matches.
cursor
stringOptional
The cursor to resume iteration from. If not provided, then iteration starts from the beginning.
limit
integerOptional
Max number of organization schedules returned in a page. Default is 50.
mode
enumOptional
The iteration mode to use. If "after", then entries after the provided cursor will be returned, or if no cursor is provided, then from the beginning. If "before", then entries before the provided cursor will be returned, or if no cursor is provided, then from the end. Entries will always be returned in the specified sort-by order.
Allowed values: afterbefore
status
list of enumsOptional
The organization schedule statuses the filter matches.
Allowed values: archiveddraftpublished
valid_until
unionOptional
Provides ways to specify date ranges on objects.

Response

This endpoint returns an object
org_schedules
list of objects
The list of organization schedules.
next_cursor
stringOptional
The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.
prev_cursor
stringOptional
The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.
POST
1curl -X POST https://api.devrev.ai/org-schedules.list \
2     -H "Authorization: <apiKey>" \
3     -H "Content-Type: application/json" \
4     -d '{}'
200
Successful
1{
2  "org_schedules": [
3    {
4      "id": "id",
5      "status": "archived",
6      "created_date": "2023-01-01T12:00:00Z",
7      "display_id": "display_id",
8      "min_valid_days": 1,
9      "modified_date": "2023-01-01T12:00:00Z",
10      "name": "name",
11      "org_schedule_fragments": [
12        {}
13      ],
14      "timezone": "timezone",
15      "valid_until": "2023-01-01T12:00:00Z",
16      "weekly_org_schedules": [
17        {}
18      ]
19    }
20  ],
21  "next_cursor": "next_cursor",
22  "prev_cursor": "prev_cursor"
23}
Built with