SMsmartling
workflows

List workflows

Changed on

Returns the workflows in the account that the authenticated user is allowed to use for content assignment or authoring, together with their steps and the locale coverage of each step.

All filter fields are optional. Regardless of which filters are supplied, each returned workflow includes its full step/action snapshot.

limit is clamped to the range 1-500 (default 100). Neither the returned workflows nor each workflow's workflowSteps are sorted in any guaranteed order.

post/workflows-api/v3/accounts/{accountUid}/workflows

Request

  • Base URL
    https://api.smartling.com
  • Auth
    HTTP bearer

Path parameters

accountUidstring required

The account’s unique identifier. This can be found in the Smartling Dashboard under Account Settings > API.

Request body

projectIdstring

Unique identifier of a Smartling project — 9 lowercase alphanumeric characters.

keywordstring

Filter by workflow name (case-insensitive substring match).

localeIdsLocaleId[]

Restrict to workflows covering any of these locales.

workflowUidsWorkflowUid[]

Restrict to these workflow UIDs.

workflowStepUidsWorkflowStepUid[]

Restrict to workflows containing any of these steps.

localePairManagementType'CUSTOM' | 'PROJECT' | 'LOCKED'

How a workflow's locale-pair coverage is managed: CUSTOM (account-level workflow with its own explicit locale pairs), PROJECT (project-level workflow), or LOCKED (locale pairs fixed by the system).

limitinteger

Maximum number of results. Clamped to the range 1-500.

Example request

{
  "projectId": "84c012a33",
  "keyword": "hello",
  "localeIds": [
    "en-US",
    "fr-FR"
  ],
  "workflowUids": [
    "5449a8595ae4"
  ],
  "workflowStepUids": [
    "7564fc097a85"
  ],
  "localePairManagementType": "CUSTOM"
}

Response

Allowed workflows retrieved.

Example response

{
  "response": {
    "data": {
      "totalCount": 1,
      "items": [
        {
          "workflowUid": "5449a8595ae4",
          "workflowName": "WF-0",
          "contentTypeUid": "e38e7731d",
          "localePairs": [
            {
              "sourceLocaleId": "fr-FR",
              "targetLocaleIds": [
                "de-DE",
                "fr-FR",
                "it-IT",
                "es-ES"
              ]
            }
          ],
          "workflowSteps": [
            {
              "workflowStepUid": "7564fc097a85",
              "workflowStepName": "A1",
              "workflowStepType": "TRANSLATION",
              "workflowStepOrder": 1,
              "localePairs": [
                {
                  "sourceLocaleId": "fr-FR",
                  "targetLocaleIds": [
                    "de-DE",
                    "fr-FR",
                    "it-IT",
                    "es-ES"
                  ]
                }
              ],
              "actions": [
                {
                  "actionType": "TRANSLATION_SUBMITTED",
                  "nextWorkflowStepUid": "7564fc097a85"
                }
              ]
            }
          ]
        }
      ]
    }
  }
}

Changes