Schedules
Users

List user schedules

Returns a paginated list of schedules for a specific user, in descending order.

get/v1/users/{user_id}/schedules

Path parameters

user_idstring required

The user ID to list schedules for.

Query parameters

workflowstring

The workflow key to filter schedules for.

tenantstring

The tenant ID to filter schedules for.

afterstring

The cursor to fetch entries after.

beforestring

The cursor to fetch entries before.

page_sizeinteger

The number of items per page (defaults to 50).

Response

OK

Example response

{
  "entries": [
    {
      "__typename": "Schedule",
      "actor": null,
      "data": null,
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "inserted_at": "2021-01-01T00:00:00Z",
      "last_occurrence_at": null,
      "next_occurrence_at": null,
      "recipient": {
        "__typename": "User",
        "avatar": null,
        "created_at": null,
        "email": "jane@ingen.net",
        "id": "jane",
        "name": "Jane Doe",
        "phone_number": null,
        "timezone": null,
        "updated_at": "2024-05-22T12:00:00Z"
      },
      "repeats": [
        {
          "__typename": "ScheduleRepeat",
          "day_of_month": null,
          "days": [
            "mon",
            "tue",
            "wed",
            "thu",
            "fri",
            "sat",
            "sun"
          ],
          "frequency": "daily",
          "hours": null,
          "interval": 1,
          "minutes": null
        }
      ],
      "tenant": null,
      "updated_at": "2021-01-01T00:00:00Z",
      "workflow": "workflow_123"
    }
  ],
  "page_info": {
    "__typename": "PageInfo",
    "after": null,
    "before": null,
    "page_size": 25
  }
}

Changes

Changed in 2 of the 30 revisions of this API.12

    • the response property entries/items/repeats/items/__typename became optional for the status 200

      response-property-became-optional

    • added the optional property entries/items/actor/oneOf[subschema #1: Recipient]/oneOf[subschema #2: Object]/properties to the response with the 200 status

      response-optional-property-added

    • added the optional property entries/items/recipient/oneOf[subschema #2: Object]/properties to the response with the 200 status

      response-optional-property-added