--- title: "List object schedules" method: GET path: "/v1/objects/{collection}/{id}/schedules" tags: ["Schedules", "Objects"] --- # List object schedules `GET /v1/objects/{collection}/{id}/schedules` Returns a paginated list of schedules for an object. ## Path parameters - `id` string, required - `collection` string, required ## Query parameters - `tenant` string - `workflow` string - `after` string - `before` string - `page_size` integer ## Response `200` OK - ListSchedulesResponse — A response containing a list of schedules. - `entries` Schedule[], required — A list of schedules. - `__typename` string — The typename of the schema. - `actor` union — A map of properties describing a user or an object to identify in Knock and mark as who or what performed the action. - User — A [User](/concepts/users) represents an individual in your system who can receive notifications through Knock. Users are the most common recipients of notifications and are always referenced by your internal identifier. - `__typename` string, required — The typename of the schema. - `avatar` string, nullable — A URL for the avatar of the user. - `created_at` string, date-time, nullable — The creation date of the user from your system. - `email` string, nullable — The primary email address for the user. - `id` string, required — The unique identifier of the user. - `name` string, nullable — Display name of the user. - `phone_number` string, nullable — The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the user (required for SMS channels). - `timezone` string, nullable — The timezone of the user. Must be a valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Used for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients). - `updated_at` string, date-time, required — The timestamp when the resource was last updated. - Object — A custom [Object](/concepts/objects) entity which belongs to a collection. - `__typename` string, required — The typename of the schema. - `collection` string, required — The collection this object belongs to. - `created_at` string, date-time, nullable — Timestamp when the resource was created. - `id` string, required — Unique identifier for the object. - `properties` object — The custom properties associated with the object. - `updated_at` string, date-time, required — The timestamp when the resource was last updated. - unknown - `data` object, nullable — An optional map of data to pass into the workflow execution. There is a 10MB limit on the size of the full `data` payload. Any individual string value greater than 1024 bytes in length will be [truncated](/developer-tools/api-logs#log-truncation) in your logs. - `id` string, uuid, required — Unique identifier for the schedule. - `inserted_at` string, date-time, required — Timestamp when the resource was created. - `last_occurrence_at` string, date-time, nullable — The last occurrence of the schedule. - `next_occurrence_at` string, date-time, nullable — The next occurrence of the schedule. - `recipient` union, required — A recipient of a notification, which is either a user or an object. - object — A [User](/concepts/users) represents an individual in your system who can receive notifications through Knock. Users are the most common recipients of notifications and are always referenced by your internal identifier. - `__typename` string, required — The typename of the schema. - `avatar` string, nullable — A URL for the avatar of the user. - `created_at` string, date-time, nullable — The creation date of the user from your system. - `email` string, nullable — The primary email address for the user. - `id` string, required — The unique identifier of the user. - `name` string, nullable — Display name of the user. - `phone_number` string, nullable — The [E.164](https://www.twilio.com/docs/glossary/what-e164) phone number of the user (required for SMS channels). - `timezone` string, nullable — The timezone of the user. Must be a valid [tz database time zone string](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones). Used for [recurring schedules](/concepts/schedules#scheduling-workflows-with-recurring-schedules-for-recipients). - `updated_at` string, date-time, required — The timestamp when the resource was last updated. - object — A custom [Object](/concepts/objects) entity which belongs to a collection. - `__typename` string, required — The typename of the schema. - `collection` string, required — The collection this object belongs to. - `created_at` string, date-time, nullable — Timestamp when the resource was created. - `id` string, required — Unique identifier for the object. - `properties` object — The custom properties associated with the object. - `updated_at` string, date-time, required — The timestamp when the resource was last updated. - `repeats` ScheduleRepeatRule[], required — The repeat rule for the schedule. - `__typename` string — The typename of the schema. - `day_of_month` integer, nullable — The day of the month to repeat the schedule. - `days` string[], nullable — The days of the week to repeat the schedule. - `frequency` 'daily' | 'weekly' | 'monthly' | 'hourly', required — The frequency of the schedule. - `hours` integer, nullable — The hour of the day to repeat the schedule. - `interval` integer — The interval of the schedule. - `minutes` integer, nullable — The minute of the hour to repeat the schedule. - `tenant` string, nullable — The tenant to trigger the workflow for. Triggering with a tenant will use any tenant-level overrides associated with the tenant object, and all messages produced from workflow runs will be tagged with the tenant. - `updated_at` string, date-time, required — The timestamp when the resource was last updated. - `workflow` string, required — The workflow the schedule is applied to. - `page_info` PageInfo, required — Pagination information for a list of resources. - `__typename` string, required — The typename of the schema. - `after` string, nullable — The cursor to fetch entries after. - `before` string, nullable — The cursor to fetch entries before. - `page_size` integer, required — The number of items per page (defaults to 50). --- [API](https://skmtc.net/knocklabs/apis/knock-api.md) · [All operations](https://skmtc.net/knocklabs/apis/knock-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/knocklabs/knock-api/revisions/4b8499dddbc5/schema)