Sign in
Workflows

List all workflows

Changed on

Retrieve a list of workflows available to the authenticated user.

get/workflows

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/workflows
  • Auth: one of:
    • HTTP bearer
    • API key in cookie immich_access_token
    • API key in header x-api-key

Query parameters

descriptionstring

Workflow description

enabledboolean

Workflow enabled

idstring uuid

Workflow ID

namestring

Workflow name

trigger'AssetCreate' | 'AssetMetadataExtraction'

Plugin trigger type

Workflow trigger type

Response

createdAtstring required

Creation date

descriptionstring nullable required

Workflow description

enabledboolean required

Workflow enabled

idstring uuid required

Workflow ID

namestring nullable required

Workflow name

trigger'AssetCreate' | 'AssetMetadataExtraction' required

Plugin trigger type

updatedAtstring required

Update date

Changes

  • 2cd7bd44a940Revision changes
    • info

      the / response's property pattern ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12})$ was added for the status

  • f5e391d20316Revision changes
    • breaking

      removed the enum value PersonRecognized from the query request parameter trigger

    • info

      removed the PersonRecognized enum value from the / response property for the response status