Skip to content

Get all Device Groups in the Target List
Stable

Request

Retrieves all Device Groups attached to a Target List.

Returns a paginated list of Device Group objects linked to the specified Target List; use this to see which groups of devices a pipeline's targeting definition includes, as a complement to any individually listed Targets.

About Device Groups in Target Lists

A Target List can target devices either directly, via individual Targets, or in bulk by attaching a Device Group — every device in an attached group becomes a target for that Stage. This endpoint returns only the Device Group side of a Target List's targeting; individual Targets are retrieved via a separate endpoint.

Security
pipelines_SCAPIAuthToken
Path
pipeline_idstringrequired

ID of the Pipeline

targetlist_idstringrequired

ID of the Target List

cURL
curl -i -X GET \
  'https://api.esper.io/_mock/openapi/pipelines/v0/pipelines/{pipeline_id}/targetlists/{targetlist_id}/devicegroups/' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

All Device Groups in Target List

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