Sign in
Workflows

List workflows

get/organizations/{organization}/databases/{database}/workflows

Path parameters

organizationstring required

The name of the organization the workflow belongs to

databasestring required

The name of the database the workflow belongs to

Query parameters

betweenstring

Filter workflows to those active during a time range (e.g. 2025-01-01T00:00:00Z..2025-01-01T23:59:59)

pageinteger

If provided, specifies the page offset of returned results

per_pageinteger

If provided, specifies the number of returned results

Response

Returns workflows

typestring required

The response type. Always "list" for paginated responses.

current_pageinteger required

The current page number

per_pageinteger required

The maximum number of results per page

next_pageinteger nullable required

The next page number, or null when this is the last page

next_page_urlstring nullable required

The next page of results, or null when this is the last page

prev_pageinteger nullable required

The previous page number, or null when this is the first page

prev_page_urlstring nullable required

The previous page of results, or null when this is the first page

Changes

Changed in 3 of the 24 revisions of this API.202

  • 4b2e4f05bda21See the full diff
    • ○

      added the required property per_page to the response with the 200 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 72506953f367181See the full diff
    • ▲

      the response property data/items/branch/deleted_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/cancelled_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/completed_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/cutover_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/data_copy_completed_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/global_keyspace/deleted_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/retried_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/reversed_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/source_keyspace/deleted_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/started_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/switch_primaries_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/switch_replicas_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/target_keyspace/deleted_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property data/items/verify_data_at became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property next_page became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property next_page_url became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property prev_page became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property prev_page_url became nullable for the status 200

      response-property-became-nullable

    • ○

      added the required property type to the response with the 200 status

      response-required-property-added

  • d710019068fb2See the full diff
    • ▲

      for the query request parameter page, the type/format was changed from number/ to integer/

      request-parameter-type-changed

    • ▲

      for the query request parameter per_page, the type/format was changed from number/ to integer/

      request-parameter-type-changed