Skip to main content

List workflows

GET /projects/:projectid/workflows

The workflows your key is allowed to read.

Returns the project's workflows, filtered to those your key holds read permission on. A key granted read on all workflows sees everything; a key scoped to one workflow sees only that one.

Authentication

  • Project API key: The credential for everything external. Created in Project Settings, bound to one project, and limited to the scopes it was granted. Format: proj.<keyId>.<secret>.
  • Required permission: workflows.read on each workflow.

Path parameters

NameTypeRequiredDefaultDescription
projectidstringYes-The project id.

Example request

curl -X GET \
-H "Authorization: proj.KEY_ID.SECRET" \
{{BASE_URL}}/projects/{{PROJECT_ID}}/workflows

Responses

200

The workflows this key can read.

{
"workflows": [
{
"id": "wf_8fK2p",
"name": "Invoice extractor",
"description": "Pulls line items out of a PDF invoice."
}
]
}

401

Missing, invalid or disabled key.