Documentation | Schedules › List Schedules

API Reference

Schedules

schedules

Methods

Create Schedules -> Array<

Schedule

post/v1/schedules

Create schedules

Delete Schedules -> Array<

Schedule

delete/v1/schedules

Delete schedules

List Schedules -> EntriesCursor<

Schedule

get/v1/schedules

List schedules

Parameters

workflow: string

Filter by workflow

after: string

Optional

The cursor to fetch entries after

before: string

Optional

The cursor to fetch entries before

page_size: number

Optional

The page size to fetch

recipients: Array<

Optional

Filter by recipient

UnionMember0 = string

A user identifier

ObjectReference = { id, collection }

An object reference to a recipient

tenant: string

Optional

Filter by tenant

Response fields

entries: Array<

Schedule

The list of schedules

page_info: { __typename, page_size, after, 1 more... }

The information about a paginated result

Request example

curl https://api.knock.app/v1/schedules \
    -H "Authorization: Bearer $KNOCK_API_KEY" \
    -d '{}'

200Example

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

Update Schedules -> Array<

Schedule

put/v1/schedules

Update schedules

Domain types

Schedule = { id, inserted_at, recipient, 9 more... }

A schedule that represents a recurring workflow execution

ScheduleRepeatRule = { __typename, frequency, day_of_month, 4 more... }

A schedule repeat rule