Skip to main content
GET
List workspace syncs

Path Parameters

workspaceId
string<uuid>
required

Workspace identifier.

Query Parameters

after
string

Cursor pointing to the last item of the previous page. Obtain this from the nextCursor field in the response.

includeCount
boolean
default:false

Whether to include the total item count in the response's total field. Defaults to false, since counting is an extra query; set it to true only when the count is actually needed.

limit
integer<uint32>

The maximum number of records to return (1-100, default: 20).

Required range: 1 <= x <= 100
provider
string[]

Filter by connection provider (s3, azure, gcs). Repeatable; a sync matches if its connection uses any of the given providers. Empty means no provider filter.

status

Filter by sync status.

Allowed value: "pending"

Response

Generic paginated response wrapper.

Provides a consistent structure for all paginated API responses with cursor-based pagination support. When next_cursor is present, there are more items to fetch.

Generic paginated response wrapper.

Provides a consistent structure for all paginated API responses with cursor-based pagination support. When next_cursor is present, there are more items to fetch.

items
object[]
required

Items in this page.

nextCursor
string

Cursor to fetch the next page. Present only when more items exist.

total
integer<int64>

Total count of items matching the query (if requested).