Schedules

List Org Schedules (POST)

Gets list of organization schedules.

POST
/org-schedules.list
AuthorizationBearer <token>

All the DevRev APIs require a token to authenticate the user. Provide Authorization: Bearer <TOKEN> as a header to every API request. How do I find my token?

In: header

created_by_id?array<string>

Creator ID the filter matches.

cursor?string

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

Formattext
limit?integer

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

Formatint32
mode?list-mode

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.

Value in"after" | "before"
status?array<org-schedule-status>

The organization schedule statuses the filter matches.

valid_until?date-filter

Provides ways to specify date ranges on objects.

after?string

Filters for objects created after the provided timestamp (inclusive).

Formatdate-time
before?string

Filters for objects created before the provided timestamp (inclusive).

Formatdate-time

Provides preset types for date filter.

daysinteger

The range starts from the current timestamp and continues for the past n days.

Range0 <= value <= 4294967295
daysinteger

The range starts from the current timestamp and continues for the next n days.

Range0 <= value <= 4294967295

Response Body

curl -X POST "https://api.devrev.ai/org-schedules.list" \  -H "Content-Type: application/json" \  -d '{}'
{
  "next_cursor": "string",
  "org_schedules": [
    {
      "created_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "created_date": "2023-01-01T12:00:00.000Z",
      "display_id": "string",
      "id": "string",
      "modified_by": {
        "type": "dev_user",
        "display_id": "string",
        "id": "string",
        "display_name": "string",
        "display_picture": {
          "display_id": "string",
          "id": "string",
          "file": {
            "type": "string",
            "name": "string",
            "size": 0
          }
        },
        "email": "string",
        "full_name": "string",
        "state": "active"
      },
      "modified_date": "2023-01-01T12:00:00.000Z",
      "default_weekly_org_schedule": {},
      "min_valid_days": 0,
      "name": "string",
      "org_schedule_fragments": [
        {}
      ],
      "status": "archived",
      "timezone": "string",
      "valid_until": "2023-01-01T12:00:00.000Z",
      "weekly_org_schedules": [
        {}
      ]
    }
  ],
  "prev_cursor": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "artifact_already_attached_to_a_parent",
  "existing_parent": "string",
  "is_same": true
}
{
  "detail": "string",
  "message": "string",
  "type": "unauthenticated"
}
{
  "detail": "string",
  "message": "string",
  "type": "forbidden"
}
{
  "detail": "string",
  "message": "string",
  "type": "too_many_requests",
  "retry_after": 0
}
{
  "detail": "string",
  "message": "string",
  "type": "internal_error",
  "reference_id": "string"
}
{
  "detail": "string",
  "message": "string",
  "type": "service_unavailable"
}