Org Schedules List

GET

Gets list of organization schedules.

Query parameters

created_by_idstringOptional

Creator ID the filter matches.

cursorstringOptional

The cursor to resume iteration from. If not provided, then iteration starts from the beginning.

limitintegerOptional

Max number of organization schedules returned in a page. Default is 50.

mode"after" or "before"Optional

The iteration mode to use, otherwise if not set, then “after” is used.

Allowed values: afterbefore

statusenumOptional

The organization schedule statuses the filter matches.

Allowed values: archiveddraftpublished

Response

This endpoint returns an object.

org_scheduleslist of objects

The list of organization schedules.

next_cursorstringOptional

The cursor used to iterate subsequent results in accordance to the sort order. If not set, then no later elements exist.

prev_cursorstringOptional

The cursor used to iterate preceding results in accordance to the sort order. If not set, then no prior elements exist.

GET

1 curl https://api.devrev.ai/org-schedules.list \
2      -H "Authorization: Bearer <token>"

200Retrieved

1 {
2   "org_schedules": [
3     {
4       "id": "id",
5       "status": "archived",
6       "created_by": {
7         "type": "sys_user",
8         "id": "created_by"
9       },
10       "created_date": "2023-01-01T12:00:00Z",
11       "default_weekly_org_schedule": {
12         "key": "value"
13       },
14       "display_id": "display_id",
15       "min_valid_days": 1,
16       "modified_by": {
17         "type": "sys_user",
18         "id": "modified_by"
19       },
20       "modified_date": "2023-01-01T12:00:00Z",
21       "name": "name",
22       "org_schedule_fragments": [
23         {
24           "key": "value"
25         }
26       ],
27       "timezone": "timezone",
28       "valid_until": "2023-01-01T12:00:00Z",
29       "weekly_org_schedules": [
30         {
31           "key": "value"
32         }
33       ]
34     }
35   ],
36   "next_cursor": "next_cursor",
37   "prev_cursor": "prev_cursor"
38 }

Built with

1	curl https://api.devrev.ai/org-schedules.list \
2	-H "Authorization: Bearer <token>"

1	{
2	"org_schedules": [
3	{
4	"id": "id",
5	"status": "archived",
6	"created_by": {
7	"type": "sys_user",
8	"id": "created_by"
9	},
10	"created_date": "2023-01-01T12:00:00Z",
11	"default_weekly_org_schedule": {
12	"key": "value"
13	},
14	"display_id": "display_id",
15	"min_valid_days": 1,
16	"modified_by": {
17	"type": "sys_user",
18	"id": "modified_by"
19	},
20	"modified_date": "2023-01-01T12:00:00Z",
21	"name": "name",
22	"org_schedule_fragments": [
23	{
24	"key": "value"
25	}
26	],
27	"timezone": "timezone",
28	"valid_until": "2023-01-01T12:00:00Z",
29	"weekly_org_schedules": [
30	{
31	"key": "value"
32	}
33	]
34	}
35	],
36	"next_cursor": "next_cursor",
37	"prev_cursor": "prev_cursor"
38	}