Skip to content

Get all Target Lists attached to the Stage
Stable

Request

Retrieves all Target Lists currently attached to a Pipeline stage.

Returns the Target Lists linked to the specified stage, which determine which devices or device groups the stage will act on when the pipeline runs.

About Stage Target Lists Pipelines orchestrate multi-step device operations through Stages, each of which executes against one or more Target Lists (collections of devices or device groups). Attaching a Target List to a Stage is what tells that step of the pipeline which devices to target.

Key Fields / Query Parameters

  • stage_id — UUID of the Stage whose attached Target Lists you want to retrieve
  • type — Optional query filter to scope the returned Target Lists by type
Security
pipelines_SCAPIAuthToken
Path
stage_idstring, (uuid)required

ID of the Stage

Query
typestring
Enum:"groups""devices""collections"
cURL
curl -i -X GET \
  'https://develop-api.esper.io/_mock/openapi/pipelines/v0/stages/{stage_id}/targetlists/?type=groups' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

All Targets Lists attached to the Stage

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