Sign in

Get v0 city by city name beads

Changed on

Results are ordered (created_at DESC, id DESC) — newest beads first. A truncated response always carries next_cursor; passing it back returns the next page in the same order. Invalid or legacy cursors are rejected with a typed 400 (invalid-cursor).

get/v0/city/{cityName}/beads

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

cityNamestring required

City name.

Query parameters

indexstring

Event sequence number; when provided, blocks until a newer event arrives.

waitstring

How long to block waiting for changes (Go duration string, e.g. 30s). Default 30s, max 2m.

cursorstring

Opaque keyset pagination token from a previous response's next_cursor field. Invalid or legacy tokens are rejected with a typed 400 (invalid-cursor); re-fetch the first page.

limitinteger

Maximum number of results to return. Omitted or 0 = server default (100). Values above 1000 are rejected.

statusstring

Filter by bead status.

typestring

Filter by bead type.

labelstring

Filter by label.

assigneestring

Filter by assignee.

rigstring

Filter by rig.

allboolean

Include closed beads.

Response

OK

next_cursorstring

Cursor for the next page of results.

partialboolean

True when one or more backends failed and the list is incomplete.

partial_errorsstring[] nullable

Human-readable errors from backends that failed during aggregation.

totalinteger required

Total number of items matching the query.

Changes

  • 04d6dfe60530Revision changes
    • ○

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

  • 68d02733ae1cRevision changes
    • ▲

      for the query request parameter limit, default value 100 was added

    • ●

      for the query request parameter limit, the max was set to 1000.00