Schedules

List schedules

Changed on

Returns a paginated list of schedules for the current environment, filtered by workflow and optionally by recipients and tenant.

get/v1/schedules

Request

  • Base URL: https://api.knock.app
  • URL: https://api.knock.app/v1/schedules
  • Auth: HTTP bearer

Query parameters

workflowstring required

Filter by workflow key.

Filter by recipient references.

[
  "user_123"
]
tenantstring

Filter by tenant ID.

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

  • e5a7933b414dRevision changes
    • breaking

      the response property //// became optional for the status

    • warning

      for the query request parameter recipients[], the type of property items/ changed from string to no type

  • 923618cb1489Revision changes
    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property //// to the response with the status