GET
https://www.app.ocoya.com/api/_public/v1/workflow/{workflowId}
List information about the workflow
curl --request GET \
  --url https://www.app.ocoya.com/api/_public/v1/workflow/{workflowId} \
  --header 'X-API-Key: <api-key>'
{
  "id": "cmajvvb9q0003ja5vh0538j6r",
  "createdAt": "2024-01-01T00:00:00Z",
  "name": "RSS to LinkedIn",
  "on": true,
  "steps": [
    {
      "id": "cmajvvbcc0005ja5v8f0d2k3m",
      "position": 0,
      "type": "trigger-rss",
      "name": "RSS feed",
      "socialProfile": null,
      "options": {
        "url": "https://example.com/feed.xml"
      }
    }
  ]
}

Authorizations

X-API-Keystringheaderrequired

Your API key. Create one in Ocoya. Authorization: Bearer <key> works too.

Path Parameters

workflowIdstringrequired

Ocoya workflow ID.

Example:"cmajvvb9q0003ja5vh0538j6r"

Response

application/json

Success

idstring

Workflow ID.

Example:"cmajvvb9q0003ja5vh0538j6r"
createdAtstring

When the workflow was created.

Example:"2024-01-01T00:00:00Z"
namestring | null

Workflow name.

Example:"RSS to LinkedIn"
onboolean

Whether the workflow is turned on.

Example:true
stepsobject[]

The workflow's steps, in order.

Show child attributesHide child attributes
steps.idstring

Step ID.

Example:"cmajvvbcc0005ja5v8f0d2k3m"
steps.positioninteger

Order of the step. 0 is the trigger.

Example:0
steps.typestring

Step type, for example trigger-rss, generate-text or post-to-facebook.

Example:"trigger-rss"
steps.namestring

Step name as shown in the editor.

Example:"RSS feed"
steps.socialProfileobject | null

Social profile the step acts on, for steps that post.

Show child attributesHide child attributes
steps.socialProfile.idstring
Example:"clh49poxf008x8kov4ncbjty9"
steps.socialProfile.namestring | null
Example:"Ocoya"
steps.socialProfile.providerstring
Example:"linkedin"
steps.optionsobject

The step's settings.

Example:
{
  "url": "https://example.com/feed.xml"
}