---
title: "List"
method: GET
path: "/orchestrations/list"
tags: ["Orchestrations"]
---

# List

`GET /orchestrations/list`

List orchestrations. Results are sorted from most recent to oldest.

## Query parameters

- `from` string
- `limit` integer
- `status` string[]
- `type` string[]
- `channels` string[]

## Headers

- `X-Batch-Project` string, required

## Response `200`

Successful response with a list of orchestrations.

- object
  - `orchestrations` union[]
    - union
      - Campaign — Details for a campaign orchestration.
        - `id` string — Unique identifier for the orchestration.
        - `type` 'campaign'
        - `channels` string[] — Channels used by the orchestration.
        - `platforms` string[] — Platforms targeted by the orchestration.
        - `source` string — Source of the orchestration creation.
        - `created_date` string, date-time — Date and time when the orchestration was created.
        - `name` string — Name of the orchestration.
        - `labels` string[] — Labels associated with the orchestration.
        - `status` 'draft' | 'running' | 'completed' | 'stopped' — Current status of the orchestration.
        - `start_time` string, date-time — Date and time when the orchestration started.
        - `has_mobile_landing` boolean — Whether a mobile landing is attached to the push.
      - Recurring — Details for a recurring orchestration.
        - `id` string — Unique identifier for the orchestration.
        - `type` 'recurring'
        - `channels` string[] — Channels used by the orchestration.
        - `platforms` string[] — Platforms targeted by the orchestration.
        - `source` string — Source of the orchestration creation.
        - `created_date` string, date-time — Date and time when the orchestration was created.
        - `name` string — Name of the orchestration.
        - `labels` string[] — Labels associated with the orchestration.
        - `status` 'draft' | 'running' | 'completed' | 'stopped' — Current status of the orchestration.
        - `start_time` string, date-time — Date and time when the orchestration started.
        - `recurrence` object
          - `end_time` string, date-time — End date and time for the recurrence.
          - `repeat_unit` 'WEEKLY' | 'DAILY' | 'MONTHLY' | 'YEARLY' — Unit for recurrence frequency.
          - `repeat_frequency` integer — How often the recurrence unit repeats.
        - `capping` integer — Maximum number of times the recurring orchestration can run.
        - `has_mobile_landing` boolean — Whether a mobile landing is attached to the push.
      - TriggerAutomation — Details for a trigger orchestration.
        - `id` string — Unique identifier for the orchestration.
        - `type` 'trigger'
        - `channels` string[] — Channels used by the orchestration.
        - `platforms` string[] — Platforms targeted by the orchestration.
        - `source` string — Source of the orchestration creation.
        - `created_date` string, date-time — Date and time when the orchestration was created.
        - `name` string — Name of the orchestration.
        - `labels` string[] — Labels associated with the orchestration.
        - `status` 'draft' | 'running' | 'completed' | 'stopped' — Current status of the orchestration.
        - `start_time` string, date-time — Date and time when the orchestration started.
        - `capping` integer — Maximum number of times the trigger orchestration can run.
        - `end_time` string, date-time — End date and time for the trigger orchestration.
        - `nbr_steps` integer — Total number of steps in the trigger orchestration.
        - `nbr_message_steps` integer — Number of message steps in the trigger orchestration.
        - `has_mobile_landing` boolean — Whether a mobile landing is attached to the push.
        - `message_steps` object[]
          - `step_name` string — The name of the step.
          - `step_id` string — The API identifier of the step.
      - InApp — Details for an in-app orchestration.
        - `id` string — Unique identifier for the orchestration.
        - `type` 'trigger'
        - `channels` string[] — Channels used by the orchestration.
        - `platforms` string[] — Platforms targeted by the orchestration.
        - `source` string — Source of the orchestration creation.
        - `created_date` string, date-time — Date and time when the orchestration was created.
        - `name` string — Name of the orchestration.
        - `labels` string[] — Labels associated with the orchestration.
        - `status` 'draft' | 'running' | 'completed' | 'stopped' — Current status of the orchestration.
        - `start_time` string, date-time — Start date and time for the in-app orchestration.
        - `end_time` string, date-time — End date and time for the in-app orchestration.
        - `capping` integer — Maximum number of times the trigger orchestration can run.
  - `count` integer — The total number of objects.
  - `has_more` boolean — Whether or not there are more elements available after this set. If `false`, this set comprises the end of the list.
  - `next_from` string — A cursor for use in pagination. If has_more is `true`, you can pass the value of `next_from` to a subsequent call to fetch the next page of results.

## Other responses

- `400` — The request is malformed
- `401` — The Rest API Key is not valid for this project
- `500` — Unexpected error
- `503` — Batch's services are under maintenance. Please try again later

---

[API](https://skmtc.net/batch/apis/batch-rest-api.md) · [All operations](https://skmtc.net/batch/apis/batch-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/batch/batch-rest-api/revisions/ec696334ff35/schema)