List all Workflow Versions

GET

https://api.withpersona.com/api/v1/workflow-versions

GET

/api/v1/workflow-versions

curl -G https://api.withpersona.com/api/v1/workflow-versions \
     -H "Authorization: Bearer <token>" \
     -d "filter[workflow-id]=wfl_3VghhbvDc7UuUNT8uZrqZjsk"

{
  "data": [
    {
      "id": "wfv_DRAFT123",
      "attributes": {
        "workflow-name": "KYC Review Workflow",
        "description": null,
        "status": "draft",
        "trigger-type": "trigger-api",
        "live": false,
        "rollout-label": null,
        "rollout-percentage": null,
        "last-updater": "taylor@example.com",
        "inputs": [
          {
            "name": "account_id",
            "type": "string",
            "required": true
          }
        ],
        "outputs": [
          {
            "name": "risk_score"
          }
        ],
        "created-at": "2026-03-27T18:29:41.000Z",
        "updated-at": "2026-03-27T18:31:05.000Z",
        "published-at": null
      },
      "relationships": {
        "workflow": {
          "data": {
            "type": "workflow",
            "id": "wfl_3VghhbvDc7UuUNT8uZrqZjsk"
          }
        }
      },
      "type": "workflow-version"
    },
    {
      "id": "wfv_TREATMENT123",
      "attributes": {
        "workflow-name": "KYC Review Workflow",
        "description": "Add manual review escalation",
        "status": "published",
        "trigger-type": "trigger-api",
        "live": true,
        "rollout-label": "treatment",
        "rollout-percentage": 25,
        "last-updater": "alex@example.com",
        "inputs": [
          {
            "name": "account_id",
            "type": "string",
            "required": true
          }
        ],
        "outputs": [
          {
            "name": "risk_score"
          }
        ],
        "created-at": "2026-03-26T18:22:59.828Z",
        "updated-at": "2026-03-26T18:29:41.000Z",
        "published-at": "2026-03-26T18:29:41.000Z"
      },
      "relationships": {
        "workflow": {
          "data": {
            "type": "workflow",
            "id": "wfl_3VghhbvDc7UuUNT8uZrqZjsk"
          }
        }
      },
      "type": "workflow-version"
    },
    {
      "id": "wfv_CONTROL123",
      "attributes": {
        "workflow-name": "KYC Review Workflow",
        "description": "Initial published version",
        "status": "published",
        "trigger-type": "trigger-api",
        "live": true,
        "rollout-label": "control",
        "rollout-percentage": 75,
        "last-updater": null,
        "inputs": [
          {
            "name": "account_id",
            "type": "string",
            "required": true
          }
        ],
        "outputs": [
          {
            "name": "risk_score"
          }
        ],
        "created-at": "2026-03-20T18:22:59.828Z",
        "updated-at": "2026-03-20T18:29:41.000Z",
        "published-at": "2026-03-20T18:29:41.000Z"
      },
      "relationships": {
        "workflow": {
          "data": {
            "type": "workflow",
            "id": "wfl_3VghhbvDc7UuUNT8uZrqZjsk"
          }
        }
      },
      "type": "workflow-version"
    }
  ],
  "links": {
    "prev": null,
    "next": null
  }
}

Retrieves the published versions and current draft version of a Workflow. Archived versions are not returned.

Provide the Workflow ID in filter[workflow-id], which you can copy from the Workflow in your Persona dashboard. The live, rollout-label, and rollout-percentage attributes are relative to the environment your API key belongs to: a version live in Production is not live in Sandbox. Sandbox API keys are supported, and report live: false for every version of a Workflow that is only deployed to Production.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageobjectOptional

fieldsmap from strings to stringsOptional

Comma-separated list(s) of attributes to include in the response. This can be used to customize which attributes will be serialized in the response. See Serialization for more details.

filterobjectRequired

Response headers

RateLimit-Limitinteger

The maximum number of requests permitted in the current rate limit window for the API key used to authenticate the request. Returned on every authenticated response.

RateLimit-Remaininginteger

The number of requests remaining in the current rate limit window for the API key used to authenticate the request. Returned on every authenticated response.

RateLimit-Resetinteger

The number of seconds until the current rate limit window resets. Returned on every authenticated response.

Request-IdstringOptional

The unique identifier of the API log entry that recorded this request. Starts with req_. Include this value when reaching out to Persona support. Present on every authenticated response, including error responses.

Persona-Environment-IdstringOptional

The token of the Persona environment that handled the request. Returned on every authenticated response, including most error responses.

Persona-Organization-IdstringOptional

The token of the Persona organization that handled the request. Returned on every authenticated response, including most error responses.

Response

This endpoint returns a collection of Workflow Version objects.

datalist of objects

An array of Workflow Versions

linksobject

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

429

Too Many Requests Error

Authentication

Headers

Query parameters

Response headers

Response

Errors