Skip to main content

List workflows

GET /projects/:projectid/workflows

Returns workflow metadata for the workflows your key can read. This does not execute any workflow or return its node graph.

Authentication and permissions​

Send a valid project key in Authorization, without Bearer. Results are filtered by workflows.read on each workflow:

  • Read access on all workflows includes every workflow in the project.
  • Read access on selected workflows includes only those workflows.
  • A key with no workflow read permissions receives an empty list, not a 403 error.
  • Run permission alone does not make a workflow visible here.

Request​

Replace :projectid with the project ID associated with the key. No body, pagination parameters, or filters are required.

Using the environment variables from the Quickstart:

curl --include --request GET \
--header "Authorization: ${INTELLECTIBLE_PROJECT_API_KEY}" \
"${INTELLECTIBLE_PUBLIC_API_URL}/projects/${INTELLECTIBLE_PROJECT_ID}/workflows"

Response​

200 OK returns a workflows array. This illustrative response shows common metadata fields; additional fields may be present, and optional metadata may be absent:

{
"workflows": [
{
"id": "example-workflow-id",
"name": "Greeting",
"description": "Return a greeting for a supplied name."
}
]
}

Use id as :workflowid in run and status requests. An empty project—or a key with no readable workflows—returns:

{
"workflows": []
}

Do not rely on a particular ordering.

Errors​

  • 401: missing, invalid, disabled, or wrong-project key.
  • 429: a key or project request-rate limit was reached.

See Authentication and permissions if an expected workflow is missing. To execute one, continue with Run a workflow or Queue a workflow run.