List information about the workflow

get

Returns information about all workflow steps

Authorizations

ApiKeyAuth

X-API-KeystringRequired

Path parameters

workflowIdstringRequiredExample: cmajvvb9q0003ja5vh0538j6r

Responses

200

Success

No content

500

Unknown error

get

/workflow/{workflowId}

HTTPcURLJavaScriptPython

GET /api/_public/v1/workflow/{workflowId} HTTP/1.1
Host: app.ocoya.com
X-API-Key: YOUR_API_KEY
Accept: */*

No content

Sample response

{
    "id": "cmiqqfj4w001413vf9mvdlwgs",
    "createdAt": "2025-12-04T01:03:27.392Z",
    "name": "Mention responder",
    "on": true,
    "steps": [
        {
            "id": "cmiqqfj51001513vfxyrgnkq4",
            "name": "New mention",
            "options": null
        },
        {
            "id": "cmiqqfj53001613vfs9qq50c9",
            "name": "Use AI agent",
            "options": {
                "text": "reply to this mention of you: {{ NEW_MENTION.text }}",
                "images": []
            }
        },
        {
            "id": "cmiqqfj56001713vffke7ofn7",
            "name": "Reply in comments",
            "options": {
                "replies": [
                    "All set! 👍",
                    "Sent to you! 👏",
                    "Done! ✅"
                ]
            }
        }
    ]
}