Workflows

Query workflows

Changed on

Use when listing or auditing workflow runs (e.g. ops dashboard or debugging). Returns a paginated list; supports filtering by workflow type and status.

post/workflows/search

Request

  • Base URL
    https://us.api.flexprice.io/v1
  • URL
    https://us.api.flexprice.io/v1/workflows/search
  • Auth
    API key in header x-api-key

Request body

end_timestring date-time
entitystring

e.g. plan, invoice, subscription

entity_idstring

e.g. plan_01ABC123

expandstring
limitinteger
offsetinteger
order'asc' | 'desc'
start_timestring date-time
status'published' | 'deleted' | 'archived'
task_queuestring
workflow_idstring

Workflow-specific filters

workflow_statusstring

e.g. Running, Completed, Failed

workflow_typestring

Response

OK

Changes

  • f8ecf435d25dRevision changes
    • warning

      added the new not_implemented enum value to the response property for the response status

    • warning

      added the new not_implemented enum value to the response property for the response status

    • info

      added the new gte enum value to the request property //

  • 646d6658479bRevision changes
    • breaking

      the request property format changed from no format to date-time

    • breaking

      the request property format changed from no format to date-time