Skip to content

Get all Pipelines for the Enterprise
Stable

Request

List all pipelines for the enterprise. Retrieves all active (non-deleted) pipelines configured for the enterprise, including metadata such as name, description, active and validity status, archive state, timeout configuration, and whether the pipeline is set as the default. Results can be filtered by name or sorted alphabetically.

About Pipelines

A pipeline is a multi-stage workflow that executes a sequence of operations — such as app installs, configuration changes, or commands — across targeted device groups. Each pipeline consists of one or more stages, each with its own target list and operation list. Pipelines allow you to coordinate staged rollouts with configurable timeouts and sequencing across your device fleet.

Common use cases

Auditing all pipelines configured for an enterprise, retrieving pipeline_id values needed to manage stages, target lists, or pipeline runs, identifying which pipelines are active or archived before triggering a run, and confirming the default pipeline configuration.

Best Practices

Use the name query parameter to filter results when working in enterprises with many pipelines. Use is_active and is_archived in the response to confirm a pipeline is in a runnable state before triggering a run. Always retrieve a pipeline_id from this endpoint before calling pipeline stage, target list, or run endpoints.

Workflow

  1. Call this endpoint to retrieve all pipelines and identify the pipeline_id for the pipeline you want to work with.
  2. Use GET /pipelines/v0/pipelines/{pipeline_id}/ to retrieve full details for a specific pipeline.
  3. Use GET /pipelines/v0/pipelines/{pipeline_id}/stages/ to inspect or modify the stages within a pipeline.
Security
pipelines_SCAPIAuthToken
Query
defaultboolean
Enum:truefalse
namestring

Filter by name

orderingstring

Sorting pipelines based on the field name

Enum:"name""-name"
cURL
curl -i -X GET \
  'https://api.esper.io/_mock/openapi/pipelines/v0/pipelines/?default=true&name=string&ordering=name' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Pipelines list for the Enterprise

Bodyapplication/json
codeinteger
messagestring
contentobject
Response
{
  "code": 0,
  "message": "string",
  "content": {
    "count": 0,
    "previous": "string",
    "next": "string",
    "results": [ … ]
  }
}