SUsuprsend

List Workflows

Changed on

Retrieve a list of workflows in a workspace.

get/v1/{workspace}/workflow/

Request

Path parameters

workspacestring required

Workspace slug (staging, production, etc.)

Query parameters

mode'draft' | 'live'

Mode to filter workflows (draft or live). By default, draft workflows are returned.

slugsstring

Comma-separated list of workflow slugs to filter. This can be used to filter workflows by slug.

limitinteger

Number of workflows to return per page (max 50).

offsetinteger

Number of workflows to skip before starting to return results.

Response

Successfully retrieved list of workflows

Example response

{
  "meta": {
    "count": 92,
    "limit": 10
  },
  "results": [
    {
      "$schema": "https://schema.suprsend.com/workflow/v1/schema.json",
      "slug": "welcome-sequence",
      "is_enabled": true,
      "name": "Welcome Sequence",
      "category": "transactional"
    }
  ]
}

Changes

  • 5f0169085547Revision changes
    • breaking

      response property detail list-of-types was widened by adding types array and object to media type application/json of response 401

    • breaking

      response property detail list-of-types was widened by adding types array and object to media type application/json of response 404

    • breaking

      the // response property's maxLength was increased from 255 to 500 for the response status

    • breaking

      the // response's property type changed from string to object for status

    • info

      added the new optional query request parameter limit

    • info

      added the new optional query request parameter offset

    • info

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

    • info

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

    • info

      the // response's property pattern was changed from ^[a-z0-9-_]+$ to ^[a-zA-Z0-9_-]+$ for the status