Service statusLog in

List orchestrations

List

get

List orchestrations.

Authorizations
AuthorizationstringRequired

API Key Authentication

Authentication is required in order to interact with Batch's APIs.

Batch implements authentication using API Keys, that we call the "REST API Key". You can find it on your dashboard.

Please make sure that you keep this key secret. You should never use it in client apps to call APIs from there as it would easily be extractable.

How to authenticate

In order to authenticate your requests, add your REST API Key in the Authorization header and prefix it by Bearer. Example: Authorization: Bearer bcd38d9rfb38ra28.

Query parameters
fromstringOptional

A cursor for pagination across multiple pages of results. Don’t include this parameter on the first call. Use the next_from value returned in a previous response to request subsequent results.

Example: eW9kYSBVRAMjAyNS0wNS0xNFQxNDo1cGRhdGUgc2FtcGxlIEFuZHJvaWMzo1NFo=
limitinteger · max: 100Optional

A limit on the number of objects to be returned.

Default: 10Example: 10
Header parameters
X-Batch-ProjectstringRequired

The unique project key, identifying a project on the Batch platform

Example: project_0664hxvwffvbpn278gxdyhsadddqgna6
Responses
200

Successful response with a list of orchestrations.

application/json
get
/orchestrations/list
GET /2.8/orchestrations/list HTTP/1.1
Host: api.batch.com
Authorization: Bearer YOUR_SECRET_TOKEN
X-Batch-Project: text
Accept: */*

{
  "orchestrations": [
    {
      "id": "orchestration_0664hyh918hr1gnzka9py5t62nrc0e1q",
      "type": "campaign",
      "channels": [
        "push"
      ],
      "platforms": [
        "ios",
        "android"
      ],
      "source": "dashboard",
      "created_date": "2017-03-02T09:43:17",
      "name": "Test Campaign 1",
      "labels": [
        "LABEL1",
        "LABEL2"
      ],
      "status": "running",
      "start_time": "2017-07-06T14:09:18"
    }
  ],
  "count": 132,
  "has_more": true,
  "next_from": "eW9kYSBVRAMjAyNS0wNS0xNFQxNDo1cGRhdGUgc2FtcGxlIEFuZHJvaWMzo1NFo="
}

Request structure

Route

The orchestration API exposes a GET endpoint that allows you to export a list of Orchestrations with key information like name, creation date, and channel.

/orchestrations/list

Headers and authentication

See Overview → Using Project APIs.

Query parameters

See the API Description.

Responses

Success

A successful GET request to this endpoint will return an HTTP 200 OK response. The body of the response will contain a JSON array of orchestration objects that match the provided query parameters.

Each orchestrations in the array includes the following fields :

  • id (string) : A unique identifier for the orchestration. This identifier can also be used to query for the orchestration's statistics.

  • type (string) : The type of orchestration. Possible values are campaign, recurring, or trigger.

  • Core details : source, name, status, created_date, start_time, channels

  • The following additional fields may also be present if applicable:

    • labels (array): An array of labels associated with the orchestration. This is available for all orchestration types.

    • recurrence (object): A block of data describing the recurrence rules. This field is only present for recurring orchestrations.

    • messages_steps (array): An array of objects, where each object represents a step in the message flow and includes its step_name and step_id. This field is only present for triggerorchestrations.

Note: The content of the messages is not included in the response.

{
  "orchestrations": [
   {
      "id": "orchestration_06bw2hjbja6dzui3r71r1vff7s1xbq63",
      "type": "onetime",
      "channels": [
        "email"
      ],
      "source": "dashboard",
      "name": "my_campaign_1",
      "status": "completed",
      "created_date": "2025-06-30T14:38:19Z",
      "labels": [
        "NEWSLETTER"
      ],
      "start_time": "2025-06-30T17:31:00Z"
    },
    {
      "id": "orchestration_068a348ws8zjtfwfxvjzpe9sv4tsqcc1k",
      "type": "recurring",
      "channels": [
        "sms"
      ],
      "source": "dashboard",
      "capping": 0,
      "recurrence": {
        "repeat_unit": "weekly",
        "repeat_fequency": 1
      },
      "name": "welcome_campaign",
      "status": "running",
      "created_date": "2025-03-30T12:00:25Z",
      "start_time": "2025-04-01T12:54:00Z"
    }
  ],
  "count": 18,
  "has_more": true,
  "next_from": "U29sZGVzX0N1aXNzYXJkc19Db3JlX0ZlbW1lX0NsaWVudHNAMjAyNS0wNi0zMFQxMjo1MzozNlo="
}

If your request returns no data, the orchestrations array will be empty.

Pagination infos:

  • next_from can be used for the next call to list to retrieve the next page

  • count is the number of items in the current page

Failure

If the GET data does not meet the API requirements you will receive an actionable error message. Contact us at support@batch.com if you need further support.

See the list of potential failures in the API Description.

PreviousOrchestrationsNextGet orchestrations stats

Last updated