Flow

Retrieve a set of flows based by query

Changed on

Used to query Flows

get/flows

Request

  • Base URL: https://api.mabl.com
  • URL: https://api.mabl.com/flows
  • Auth: one of:
    • HTTP basic
    • API key in header Authorization

Query parameters

workspace_idstring required

Restricts the query to flows associated with the given organization ID

flow_type'validate_page' | 'login' | 'verify_url' | 'mablscript' | 'check_links' | 'visual_page_validation' | 'api' | 'mobile'

Restricts the query to flows of a given type

reusableboolean

Restricts the query to reusable or non-reusable flows

has_snippetboolean

Restricts the query to flows that have or don't have snippets

snippetIdstring

Restricts the query to flows that use a given snippet

branchstring

The branch to retrieve flows from. Flows not on the branch will failover to their master versions, if they exist on master.

resolvable_on_branchboolean

If true, will only return flows that have a version that can be resolved on the specified branch

limitinteger

The limit to use for pagination

cursorstring

The cursor to use for pagination

Response

Array of flows matching the query

cursorstring

Cursor used for pagination

Changes

  • d0a5100df4c1Revision changes
    • breaking

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

    • info

      added to the /////// response property allOf list for the response status

    • info

      removed the api enum value from the /////// response property for the response status

    • info

      removed the check_links enum value from the /////// response property for the response status

    • info

      removed the login enum value from the /////// response property for the response status

    • info

      removed the mablscript enum value from the /////// response property for the response status

    • info

      removed the mobile enum value from the /////// response property for the response status

    • info

      removed the validate_page enum value from the /////// response property for the response status

    • info

      removed the verify_url enum value from the /////// response property for the response status

    • info

      removed the visual_page_validation enum value from the /////// response property for the response status

  • 213a66c2bc25Revision changes
    • info

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