FRfrigadehq
userFlowStates

GET /v1/public/flowStates

Get the state of a User in all Flows

Request

  • The document declares no server URL.
  • Auth
    HTTP bearer

Query parameters

userIdstring required

The ID of the user

groupIdstring

Optional ID of the group

Response

The Flow state for the User was found

ineligibleFlowsstring[]

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

Example response

{
  "eligibleFlows": [
    {
      "flowSlug": "flow_abc",
      "flowName": "Onboarding Checklist",
      "flowType": "ANNOUNCEMENT",
      "data": {
        "steps": [
          {
            "id": "step_abc",
            "$state": {
              "completed": true,
              "skipped": 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"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.