Retrieve a Batch

Retrieve a batch. This retrieves the batch details and status.

Endpoint

GET /v1/batches/{id}

Authorization Header

Authorization: Bearer <access_token>
or
Authorization: Basic <encodedString>
where <encodedString> is your <api-key>:<api-secret> string encoded using Base64 encoding

Path Parameters

id REQUIRED

string (UUID)

Unique ID assigned to the batch.

Request Body

None

Returns

Returns the batch details and status. For details, see the Batch object.

SAMPLE RESPONSE

				
					{
  "id": "32df8770-ee48-46e7-a8c7-9ec478883076",
  "campaignId": "05ee2300-51cd-4021-b28d-11597cf9a175",
  "description": "Spring Sale",
  "externalId": "a7896",
  "startDate": "2022-04-25",
  "endDate": "2022-04-25",
  "startTime": "02:00:00",
  "endTime": "04:00:00",
  "status": "DELIVERED",
  "createdAt": "2022-04-24T16:51:03.419Z",
  "updatedAt": "2022-04-24T16:51:03.419Z",
  "finishedAt": "2022-04-25T04:00:03.419Z"
}