CUcubesoftware
Workflow

List registered workflow types (read-only catalog).

Changed on

Returns metadata for each workflow type in the in-code registry for this company context. GET only — no create, update, or delete. Optional prefix filters entries whose type_id or workflow class FQN starts with any given prefix (repeat param or comma-separated). Without page, optional limit caps how many rows are returned (max 500). With page, the list is paginated using the same page / limit contract as other Cube list endpoints (CubePageNumberPagination): limit is the page size (default 100, max 500) and metadata.pagination is included.

get/company/workflow-types

Request

  • Base URL
    https://api.cubesoftware.com
  • Auth
    • OAuth 2
      Authorization code: https://portal.cubesoftware.com/o/authorize/
      Token URL: https://api.cubesoftware.com/o/token/
    • or none

Query parameters

limitinteger

Without page: optional cap on how many entries to return from the start of the filtered list (max 500). With page: page size (defaults to 100 when omitted, max 500); invalid values return 400.

pageinteger

When present, enables pagination (same contract as other Cube list endpoints). Out-of-range pages fall back to page 1. Response includes metadata.pagination.

prefixstring

Filter to entries whose type_id or workflow class FQN starts with this prefix. Repeat the parameter or use comma-separated values (OR logic).

Headers

HTTP_ACCEPTstring required

Set the version of API the request is for

X-Company-IDstring required

Associates request with company

Response

type_idstring required
registry_idstring required
catalog_versioninteger required
namestring required
workflow_class_pathstring required
supports_cancellationboolean required

Changes