workflows

Get workflow by ID or reference

Fetches a single workflow definition using either its resource ID or reference. Requires the WORKFLOW.VIEW permission.

get/v{version}/workflows/{resourceIdOrReference}

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/workflows/{resourceIdOrReference}
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

resourceIdOrReferencestring required

The ID or reference of the resource.

Headers

x-platform-idstring

Platform ID.

Response

OK

object_typestring nullable
idstring nullable
namestring

Name of the workflow.

descriptionstring nullable

Description of what the workflow is used for.

type'INVOICE' | 'PAYMENT' | 'PRICING_PLAN_SUBSCRIPTION' | 'WALLET' | 'USAGE'

Resource type the workflow runs for. This selects the matching workflow configuration and trigger data.

referencestring

Unique reference.

status'ACTIVE' | 'INACTIVE' | 'DRAFT' | 'ARCHIVED'

Status of the workflow.

created_atstring nullable

Date time when the workflow was created.

updated_atstring nullable

Date time when the workflow was last updated.

customer_idsstring[] nullable

Customer scope for the workflow. This limits which customers can use the workflow when it is triggered.

Changes

No recorded changes to this operation across all 1 revision of this API.