API Reference

Get list of workflows

get
https://api.approveit.today/api/v1/workflows

Returns a list of the team's workflows.

Use this endpoint to discover the identifiers needed by the other public endpoints:

  • slug is the workflow_slug accepted by POST /api/v1/approval-requests (create), POST /api/v1/approval-requests/search (search) and GET /api/v1/workflows/{slug}/fields.
  • pipeline_id is the {id} in the Inbound API URL POST /api/v1/pipelines/{id}/processes (null if the workflow is not wired into a live pipeline).

Soft-deleted workflows are excluded. Supports exact-match search by name or slug.

The response is a pagination envelope (count, next, previous, results); pass all=true to instead receive a bare array of every workflow.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string

Search by workflow name or slug (exact match)

string

Sort results. Available fields: id, name, slug, created_at. For descending order add '-' before field name. Defaults to id.

integer

Page number for pagination

integer

Number of results per page (max 100, default 20)

string

Return all results as a bare array without the pagination envelope (set to 'true')

Responses

Updated 16 days ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 16 days ago

Did this page help you?