v1

latestOpenAPI 3.0.02026-07-2664192238.8 KB

Batch

Get batches

Scopes: products.read, contacts.read, events.read <br><a href="https://www.postman.com/omnisend-api/workspace/omnisend/overview" target="_blank">Open Postman collection</a>

get/batches

Query parameters

offsetinteger

Offset (minimum 0)

limitinteger

Limit (1-250)

status'pending' | 'inProgress' | 'finished' | 'stopped'

Status

dateFromstring

Date from (format: yyyy-mm-dd)

dateTostring

Date to (format: yyyy-mm-dd)

endpoint'products' | 'contacts' | 'events' required

Endpoint

Headers

Omnisend-Versionstring required

API version that specifies the response format and behaviour

Response

List of batches

Example response

{
  "batches": [
    {
      "batchID": "5f92cbf10cf217478ba93561",
      "createdAt": "2021-01-01T00:00:00Z",
      "endedAt": "2021-01-01T00:00:00Z",
      "endpoint": "contacts",
      "errors": [
        {
          "itemID": "5f92cbf10cf217478ba93561",
          "responseCode": 200,
          "status": "finished"
        }
      ],
      "eventID": "5f92cbf10cf217478ba93561",
      "finishedCount": 100,
      "method": "POST",
      "origin": "api",
      "responses": [
        {
          "itemID": "5f92cbf10cf217478ba93561",
          "responseCode": 200,
          "status": "finished"
        }
      ],
      "startedAt": "2021-01-01T00:00:00Z",
      "status": "finished",
      "totalCount": 100
    }
  ],
  "paging": {
    "limit": 100,
    "next": "https://api.omnisend.com/api/batches?limit=100&offset=105",
    "offset": 5,
    "previous": "https://api.omnisend.com/api/batches?limit=100&offset=5"
  }
}