Skip to main content
GET
/
v1
/
flows
/
{id}
Get the data of a flow
curl --request GET \
  --url https://clientapi.woku.app/v1/flows/{id} \
  --header 'Authorization: Bearer <token>'
{
  "flowId": "<string>",
  "flowName": "<string>",
  "companyId": "<string>",
  "companyName": "<string>",
  "companyAvatar": "<string>",
  "wokusData": [
    {
      "wokuId": "<string>",
      "description": "<string>",
      "fileUrl": "<string>",
      "fileType": "<string>"
    }
  ],
  "anonymousDisabled": true,
  "npsToolId": "<string>",
  "companyIdNps": "<string>"
}

Authorizations

​
Authorization
string
header
required

Company API key. Obtain this from your Woku dashboard under Settings > API Keys. The same key used for the v0 endpoints.

Path Parameters

​
id
string
required

Flow id

Response

Flow data

​
flowId
string
​
flowName
string
​
companyId
string
​
companyName
string
​
companyAvatar
string
​
wokusData
object[]

Wokus of the journey, in presentation order.

​
anonymousDisabled
boolean
​
npsToolId
string | null

Linked NPS tool, when the flow ends with a tool-specific NPS.

​
companyIdNps
string | null

Set when the flow ends with the company-level NPS.