GET
/
v1
/
public
/
flowStates
curl --request GET \
  --url https://api.frigade.com/v1/public/flowStates \
  --header 'Authorization: Bearer <token>'
{
  "eligibleFlows": [
    {
      "flowSlug": "flow_abc",
      "flowName": "Onboarding Checklist",
      "flowType": "ANNOUNCEMENT",
      "data": {
        "steps": [
          {
            "id": "step_abc",
            "$state": {
              "completed": true,
              "started": true,
              "visible": true,
              "blocked": true,
              "lastActionAt": "2024-09-01T00:00:00.000Z"
            }
          }
        ]
      },
      "$state": {
        "currentStepId": "step_abc",
        "currentStepIndex": 1,
        "completed": true,
        "started": true,
        "skipped": true,
        "visible": true,
        "lastActionAt": "2024-09-01T00:00:00.000Z"
      }
    }
  ],
  "ineligibleFlows": [
    "<string>"
  ]
}

Authorizations

Authorization
string
headerrequired

Authentication header of the form Bearer: <token>, where <token> is your public or private Frigade API key

Query Parameters

userId
string
required

The ID of the user

groupId
string

Optional ID of the group

Response

200 - application/json
eligibleFlows
object[]

List of Flows that the user is eligible for as well as the user's state in each Flow

ineligibleFlows
string[]

List of Flow IDs that the user is ineligible for (for instance if a Flow is turned off)