Get workflow status

Poll async work such as consent revocation or field rebuilds.

GET /v1/workflows/{workflow_id}

Get async workflow status

cURL

curl --request GET \
  --url https://api.swapnice.com/v1/workflows/{workflow_id} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "type": "consent_revocation_cascade",
  "status": "accepted",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>"
  }
}

Poll async work such as consent revocation or field rebuilds.

Statuses: accepted, running, completed, failed.

Authorizations

Authorization · string · header · required

OAuth 2.1 authorization code with PKCE. Implicit and password flows are unsupported.

Path Parameters

workflow_id · string · required

Response

200

application/json

Workflow status.

id · string · required

type · enum<string> · required

Available options: consent_revocation_cascade, profile_recompute, ontology_fields_rebuild, webhook_delivery

status · enum<string> · required

Available options: accepted, running, completed, failed

created_at · string<date-time> · required

updated_at · string<date-time> · required

error · object

Show child attributes