Skip to main content

Get Flow by ID

GET 
/v1/clients/:clientID/flows/:flowId

Endpoint to retrieve a Flow for the specified id.

withChildren query parameter could be used to include flow's children in the response.

Request​

Path Parameters

    clientID stringrequired
    flowId stringrequired

Query Parameters

    withChildren string

Responses​

Successful operation

Schema
    id uuid
    clientId string
    cooldownTimeout number

    duration to wait until the next iteration of this flow can be processed.

    description string
    driver string
    enabled boolean
    sourceSystem string
    sourceSystemId string
    flows undefined[]

    Array of children flows for this flow. In other words, the flows that form the tree under this flow.

    lastEdited object
    date date-time
    editorAuthId number
    maxCompletions number

    how many times this flow can be completed for the same user.

    metadata object

    metadata can receive any JSON object.

    someField string
    name string
    parentId uuid

    reference to the flow's parent.

    replicas number

    how many events for this Flow should be completed in order to complete the flow (i.e. user has to login 5 times)

    resetThreshhold number

    duration after the latest user progress event is received in order to loss the user progress. for this flow.

    rewards string[]
    validFrom date-time

    the flow will be valid starting from this date

    validTo date-time

    the flow will be valid until this date

Loading...