v1

latestOpenAPI 3.0.32026-07-24198357534.7 KB

Data Enhancement

This endpoint provides a list of Workflows, it can be paginated with the pagination=true parameter

Retrieves the collection of Workflow resources.

get/workflows

Query parameters

pageinteger

The collection page number

limitinteger

The number of items per page

paginationboolean

Enable or disable pagination

order[name]'asc' | 'desc'

order[id]'asc' | 'desc'

order[documentType.id]'asc' | 'desc'

Response

Workflow collection

dateCreatedstring date-time nullable

This is an ISO datetime

dateModifiedstring date-time nullable

This is an ISO datetime

idstring

This is the unique identifier of the resource

documentTypeobject

legacyIdinteger

Example response

[
  {
    "name": {
      "fr-FR": "fr-FR translation",
      "en-US": "en-US translation",
      "<*>": "..."
    },
    "description": {
      "fr-FR": "fr-FR translation",
      "en-US": "en-US translation",
      "<*>": "..."
    },
    "steps": [
      {
        "id": "identifier_example",
        "name": {
          "fr-FR": "fr-FR translation",
          "en-US": "en-US translation",
          "<*>": "..."
        },
        "description": {
          "fr-FR": "fr-FR translation",
          "en-US": "en-US translation",
          "<*>": "..."
        },
        "color": "#4DABF7"
      }
    ],
    "transitions": [
      {
        "id": "identifier_example",
        "name": {
          "fr-FR": "fr-FR translation",
          "en-US": "en-US translation",
          "<*>": "..."
        },
        "originStepId": "origin_step_identifier",
        "targetStepId": "target_step_identifier",
        "permissionFeatures": [
          "permission_feature_identifier_1",
          "permission_feature_identifier_2"
        ]
      }
    ],
    "id": "identifier_example"
  }
]