TRtraversal
workers

List Workers

Changed on
get/workers

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/workers
  • Auth
    none declared

Query parameters

pageinteger

Page number for pagination

limitinteger

Number of workers per page

sort_by'status_updated_at' | 'status'

Allowlisted sort fields; every value must name a WorkerListItemResponse field.

Worker field to sort by

sort_order'asc' | 'desc'

Sort direction (asc or desc)

statusWorkerStatusFilter[] nullable

Filter by one or more rendered worker statuses. stopped is derived from stopped_at, so a stopped worker matches only stopped and never the value it last emitted.

modeMode[] nullable

Filter by one or more worker modes. Workers with no stored mode are excluded whenever this filter is set.

updated_within'24h' | '48h' | '7d' | '14d' | 'all'

Rolling window applied to status_updated_at.

Workers that go quiet drift out of the list rather than accumulating in it, which is the primary lever for orgs carrying hundreds of channels. A worker that has never reported a status has no timestamp to compare, so it falls outside every window in an unsearched list. Search ignores this window so known workers remain discoverable regardless of status recency.

Only list workers updated inside this rolling window. Workers that have never reported a status fall outside every window; pass all to include them. Ignored when search is non-empty.

searchstring nullable

Case-insensitive substring search over worker display name, rendered status, and status message across all update times

Response

Successful Response

countinteger required
previnteger nullable
nextinteger nullable
totalinteger required

Changes

  • b3082d58954dRevision changes
    • info

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

  • 3025330cc50dRevision changes
    • warning

      added the new custom enum value to the /// response property for the response status

    • info

      added the enum value custom to the property anyOf[subschema #1]/items/ of the query request parameter mode