curl --request GET \
--url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/workflows \
--header 'Authorization: <api-key>'{
"current_page": 123,
"next_page": 123,
"next_page_url": "<string>",
"prev_page": 123,
"prev_page_url": "<string>",
"data": [
{
"id": "<string>",
"name": "<string>",
"number": 123,
"state": "pending",
"created_at": "<string>",
"updated_at": "<string>",
"started_at": "<string>",
"completed_at": "<string>",
"cancelled_at": "<string>",
"reversed_at": "<string>",
"retried_at": "<string>",
"data_copy_completed_at": "<string>",
"cutover_at": "<string>",
"replicas_switched": true,
"primaries_switched": true,
"switch_replicas_at": "<string>",
"switch_primaries_at": "<string>",
"verify_data_at": "<string>",
"workflow_type": "move_tables",
"workflow_subtype": "<string>",
"defer_secondary_keys": true,
"on_ddl": "IGNORE",
"workflow_errors": "<string>",
"may_retry": true,
"may_restart": true,
"verified_data_stale": true,
"sequence_tables_applied": true,
"actor": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"verify_data_by": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"reversed_by": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"switch_replicas_by": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"switch_primaries_by": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"cancelled_by": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"completed_by": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"retried_by": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"cutover_by": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"reversed_cutover_by": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"branch": {
"id": "<string>",
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"source_keyspace": {
"id": "<string>",
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"target_keyspace": {
"id": "<string>",
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"global_keyspace": {
"id": "<string>",
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
}
}
]
}curl --request GET \
--url https://api.planetscale.com/v1/organizations/{organization}/databases/{database}/workflows \
--header 'Authorization: <api-key>'{
"current_page": 123,
"next_page": 123,
"next_page_url": "<string>",
"prev_page": 123,
"prev_page_url": "<string>",
"data": [
{
"id": "<string>",
"name": "<string>",
"number": 123,
"state": "pending",
"created_at": "<string>",
"updated_at": "<string>",
"started_at": "<string>",
"completed_at": "<string>",
"cancelled_at": "<string>",
"reversed_at": "<string>",
"retried_at": "<string>",
"data_copy_completed_at": "<string>",
"cutover_at": "<string>",
"replicas_switched": true,
"primaries_switched": true,
"switch_replicas_at": "<string>",
"switch_primaries_at": "<string>",
"verify_data_at": "<string>",
"workflow_type": "move_tables",
"workflow_subtype": "<string>",
"defer_secondary_keys": true,
"on_ddl": "IGNORE",
"workflow_errors": "<string>",
"may_retry": true,
"may_restart": true,
"verified_data_stale": true,
"sequence_tables_applied": true,
"actor": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"verify_data_by": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"reversed_by": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"switch_replicas_by": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"switch_primaries_by": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"cancelled_by": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"completed_by": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"retried_by": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"cutover_by": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"reversed_cutover_by": {
"id": "<string>",
"display_name": "<string>",
"avatar_url": "<string>"
},
"branch": {
"id": "<string>",
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"source_keyspace": {
"id": "<string>",
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"target_keyspace": {
"id": "<string>",
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
},
"global_keyspace": {
"id": "<string>",
"name": "<string>",
"created_at": "<string>",
"updated_at": "<string>",
"deleted_at": "<string>"
}
}
]
}The name of the organization the workflow belongs to
The name of the database the workflow belongs to
Filter workflows to those active during a time range (e.g. 2025-01-01T00:00:00Z..2025-01-01T23:59:59)
If provided, specifies the page offset of returned results
If provided, specifies the number of returned results
Returns workflows
Was this page helpful?