Get WhatsApp Flows

GET https://chatapps.8x8.com/api/v1/accounts/:accountId/channels/:channelId/flows

This endpoint is used to retrieve the list of WhatsApp Flows and their status for the channel.

Request

Path Parameters

    accountId stringrequired

    Possible values: >= 32 characters and <= 36 characters, Value must match regular expression ^[0-9A-Fa-f]{8}[-]?(?:[0-9A-Fa-f]{4}[-]?){3}[0-9A-Fa-f]{12}$

    You must replace {accountId} with the accountid that you want to use.

    channelId stringrequired

    Channel identifier

Query Parameters

    limit integer

    Possible values: >= 1 and <= 1000

    Maximum number of flows to return

    Default value: 100

Successful response

Schema

    flows object[]

  • Array [
  • idstring

    Flow ID

    Example: 1145805540595505
    namestring

    Flow name

    Example: Loan Collection
    statusstring

    Flow status

    Possible values: [DRAFT, PUBLISHED, DEPRECATED]

    Example: DRAFT
  • ]
{
"flows":[
{
"id":"1145805540595505",
"name":"Loan Collection",
"status":"DRAFT"
}
]
}
{
"flows":[
{
"id":"1145805540595505",
"name":"Loan Collection",
"status":"DRAFT"
},
{
"id":"802610292468882",
"name":"2025-10-08T15:17:51.241+08:00",
"status":"PUBLISHED"
}
]
}

Request was not authenticated response

Schema

    codeintegerrequired

    Error code

    messagestring

    Error description

    errorIdstring<uuid>required

    Unique id of error. You can use it as reference when sending enquiries to 8x8 support

    timestampstring<date-time>required

    Data and time of the error occurence

{
"code":1001,
"message":"Provided subAccountId doesn't belongs to your account",
"errorId":"91b106f0-c0da-4aba-a43a-7af9c5893a80",
"timestamp":"2017-04-19T02:31:19.4297387+00:00"
}
{
"code":1200,
"message":"Request was not authenticated properly",
"errorId":"db9dced4-3534-4d86-9d18-6b448af0d621",
"timestamp":"2018-08-02T09:42:38.8988997+00:00"
}

Internal server error

Schema

    codeintegerrequired

    Error code

    messagestring

    Error description

    errorIdstring<uuid>required

    Unique id of error. You can use it as reference when sending enquiries to 8x8 support

    timestampstring<date-time>required

    Data and time of the error occurence

{
"code":1001,
"message":"Provided subAccountId doesn't belongs to your account",
"errorId":"91b106f0-c0da-4aba-a43a-7af9c5893a80",
"timestamp":"2017-04-19T02:31:19.4297387+00:00"
}
{
"code":2000,
"message":"Internal server error",
"errorId":"db9dced4-3534-4d86-9d18-6b448af0d621",
"timestamp":"2018-07-02T09:42:38.8988997+00:00"
}

Source: https://developer.8x8.com/connect/reference/get-whatsapp-flows · 8x8 CPaaS Developer Docs. Synced for support deflection.

Was this article helpful?
or
0 out of 0 found this helpful

0 Comments

Please sign in to leave a comment.

Didn't find what you were looking for?

Submit a request