✅ Approval Workflows

List approval workflows

Changed on

Retrieve the workspace's published (non-draft) multi-level approval workflows. Use the returned id as approval_workflow.workflow_id when creating or updating a post. Requires the manage_workflow permission.

get/api/v1/workspaces/{workspace_id}/approval-workflows

Request

  • Base URL
    https://api.contentstudio.io
  • URL
    https://api.contentstudio.io/api/v1/workspaces/{workspace_id}/approval-workflows
  • Auth
    API key in header X-API-Key

Path parameters

workspace_idstring required
Example:610a1e660cb41530ca40d372

Workspace ID

Response

Approval workflows retrieved successfully

statusboolean
messagestring

Example response

{
  "status": true,
  "message": "Approval workflows retrieved successfully. Use a workflow's `id` as `approval_workflow.workflow_id` when creating or updating a post.",
  "data": [
    {
      "id": "66a1f2e4c8b9a1234567890d",
      "_id": "66a1f2e4c8b9a1234567890d",
      "name": "Marketing Approval",
      "levels": [
        {
          "level_number": 1,
          "title": "Editors",
          "rule": "anyone",
          "members": [
            {
              "user_id": "627a078300a7d866600e7d02"
            }
          ]
        }
      ]
    }
  ]
}

Changes

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the media type application/json for the response with the status

    • info

      added the optional property // to the response with the status