v2

latestOpenAPI 3.1.02026-08-074390396.7 KB
Batches

List batches

get/api/v1/batches

Query parameters

pageinteger

Page number

perPageinteger

Number of items per page

type'walletMessaging' | 'passCreation' | 'passUpdate'

Type of the batch

Response

Successful

Example response

{
  "data": [
    {
      "attributes": {
        "name": "PassEntry Supermarket Summer Promotion",
        "tag": "summerPromotion",
        "content": "Welcome to PassEntry Supermarket! We're excited to have you as a member. Get 10% off your first purchase by showing your pass at the till!",
        "totalRecipients": 12000,
        "completedAt": "2021-01-01T00:00:00Z",
        "scheduledAt": "2022-01-01T00:00:00Z",
        "errorsCsvUrl": "https://example.com/errors.csv"
      }
    }
  ]
}