worker-schedules
get/worker/{worker_id}/schedules

Request

  • Base URL
    https://api.traversal.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.traversal.com/worker/{worker_id}/schedules
  • Auth
    none declared

Path parameters

worker_idstring required

Query parameters

pageinteger

Page number for pagination

limitinteger

Number of schedules per page (max 1000)

status'active' | 'completed'

Visibility filter for paginated Worker schedule lists.

Active rows have no completed_at. Completed rows are one-shots that have already fired. Soft-deleted rows are never returned.

Restrict results to active schedules (completed_at is null) or completed one-shots (completed_at is set). Omit to return both.

Response

Successful Response

countinteger required
previnteger nullable
nextinteger nullable
totalinteger required

Changes

    • breaking

      response property schedules/items/created_by_user/anyOf[subschema #1: WorkerScheduleUserResponse]/email list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the //// response's property format changed from uuid to no format for status

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter page

    • info

      added the new optional query request parameter status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

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

    • info

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

    • info

      added the required property to the response with the status