get https://partner.gupshup.io/partner/app//flows
Use this API to get a list of all flows.
Request Parameters
Key | Description | Values | Data Types | Required/Optional | Constraints |
---|---|---|---|---|---|
Authorization | Access Token for the application | {{PARTNER_APP_TOKEN}} | String | Required | Should be a valid Partner App Access Token |
appId | App id of the app | {{APP_ID}} | String | Required | The Id should be a valid app Id of Gupshup |
Sample Request
curl --location --request GET 'https://partner.gupshup.io/partner/app/{{APP_ID}}/flows' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/json'
Sample Response
[
{
"validation_errors": [],
"id": "2923110437826840",
"name": "XYZ",
"status": "DRAFT",
"categories": [
"SIGN_IN"
]
},
{
"validation_errors": [],
"id": "784357546938705",
"name": "My aug12second flow",
"status": "DEPRECATED",
"categories": [
"APPOINTMENT_BOOKING"
]
},
{
"validation_errors": [],
"id": "1652582318899490",
"name": "xyz",
"status": "DRAFT",
"categories": [
"SIGN_UP"
]
},
{
"validation_errors": [],
"id": "3789351118016794",
"name": "def",
"status": "DRAFT",
"categories": [
"SIGN_UP"
]
},
{
"validation_errors": [],
"id": "2542279949289864",
"name": "abc",
"status": "DRAFT",
"categories": [
"SIGN_UP"
]
},
{
"validation_errors": [],
"id": "460001903531489",
"name": "august flow",
"status": "PUBLISHED",
"categories": [
"SIGN_UP"
]
},
{
"validation_errors": [],
"id": "1667636143985877",
"name": "My first flow",
"status": "DEPRECATED",
"categories": [
"SIGN_UP"
]
}
]
Status Codes
Status Code | Response | Comments |
---|---|---|
Success | ||
200 | [ { "validation_errors": [], "id": "2923110437826840", "name": "XYZ", "status": "DRAFT", "categories": [ "SIGN_IN" ] }, { "validation_errors": [], "id": "784357546938705", "name": "My aug12second flow", "status": "DEPRECATED", "categories": [ "APPOINTMENT_BOOKING" ] }, { "validation_errors": [], "id": "1652582318899490", "name": "xyz", "status": "DRAFT", "categories": [ "SIGN_UP" ] }, { "validation_errors": [], "id": "3789351118016794", "name": "def", "status": "DRAFT", "categories": [ "SIGN_UP" ] }, { "validation_errors": [], "id": "2542279949289864", "name": "abc", "status": "DRAFT", "categories": [ "SIGN_UP" ] }, { "validation_errors": [], "id": "460001903531489", "name": "august flow", "status": "PUBLISHED", "categories": [ "SIGN_UP" ] }, { "validation_errors": [], "id": "1667636143985877", "name": "My first flow", "status": "DEPRECATED", "categories": [ "SIGN_UP" ] } ] | Get all flows associated to app ID |
Error | ||
401 | { "status":"error", "message":"Unauthorised access to the resource. Please review request parameters and headers and retry" } | For invalid app Id or partner app token |