Get Flow

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
flowId	Flow Id	`{{FLOW_ID}}`	String	Required	Flow Id generated by Meta
fields	You can request other fields by using the fields param in the request.	`{{FIELDS}}`	String	Optional	the value would be comma separated : id,name,categories,preview,status,validation_errors,json_version,data_api_version,endpoint_uri,whatsapp_business_account,application

Sample Request

curl --location --request GET 'https://partner.gupshup.io/partner/app/{{APP_ID}}/flows/{{FLOW_ID}}?fields={{FIELDS}}' \
--header 'Authorization: {{PARTNER_APP_TOKEN}}' \
--header 'Content-Type: application/json'

Sample Response

{
    "application": {
        "id": "2281283925530161",
        "link": "https://www.gupshup.io/developer/home",
        "name": "GupShup"
    },
    "categories": [
        "APPOINTMENT_BOOKING",
        "SIGN_UP"
    ],
    "id": "1616289422261049",
    "json_version": "3.1",
    "name": "flow_dev_01",
    "preview": {
        "expires_at": "2024-07-21T10:15:47+0000",
        "preview_url": "https://business.facebook.com/wa/manage/flows/1616289422261049/preview/?token=fe2fa8b0-86bf-4d53-a6c3-eec4085ab48b"
    },
    "status": "success",
    "validation_errors": [],
    "whatsapp_business_account": {
        "currency": "INR",
        "id": "174161222453488",
        "message_template_namespace": "5928791c_e309_41df_b1d3_78e4af7954df",
        "name": "Self Serve Automation",
        "timezone_id": "71"
    }
}

Status Codes

Status Code	Response	Comments
Success
200	{ "application": { "id": "2281283925530161", "link": "https://www.gupshup.io/developer/home", "name": "GupShup" }, "categories": [ "APPOINTMENT_BOOKING", "SIGN_UP" ], "id": "1616289422261049", "json_version": "3.1", "name": "flow_dev_01", "preview": { "expires_at": "2024-07-21T10:15:47+0000", "preview_url": "https://business.facebook.com/wa/manage/flows/1616289422261049/preview/?token=fe2fa8b0-86bf-4d53-a6c3-eec4085ab48b" }, "status": "success", "validation_errors": [], "whatsapp_business_account": { "currency": "INR", "id": "174161222453488", "message_template_namespace": "5928791c_e309_41df_b1d3_78e4af7954df", "name": "Self Serve Automation", "timezone_id": "71" } }	Get flow details for flow ID
Error
400	`{ "status":"error", "message":"Unsupported get request. Object with ID '12368263876e8269o6362986738' does not exist, cannot be loaded due to missing permissions, or does not support this operation. Please read the Graph API documentation at https://developers.facebook.com/docs/graph-api" }`	For invalid flow ID