List Batches
Retrieve a list of Batches
curl --request GET \
--url https://api.passentry.com/api/v1/batches \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "8ecfc493-da04-493b-8b98-bf9d5cc29115",
"type": "walletMessaging",
"attributes": {
"name": "Summer Promotion 2",
"status": "failed",
"tag": null,
"content": "Hello, World!",
"scheduledAt": "2030-03-31T13:16:26Z"
}
},
{
"id": "8ecfc493-da04-493b-8b98-bf9d5cc29114",
"type": "walletMessaging",
"attributes": {
"name": "Summer Promotion",
"status": "scheduled",
"tag": null,
"content": "Hello, World!",
"scheduledAt": "2030-03-31T13:16:26Z"
}
}
],
"meta": {
"totalCount": 2,
"resultsPerPage": 25,
"currentPage": 1,
"totalPages": 1
},
"links": {
"first": null,
"prev": null,
"next": null,
"last": null
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Page number
Number of items per page
Type of the batch
walletMessaging Response
UUID of the batch
Type of batch
walletMessaging Friendly name of the batch, used for display purposes
"PassEntry Supermarket Summer Promotion"
Status of the batch
validating, scheduled, failed, sending, successful, completedWithErrors, cancelled Tag of the batch, used for grouping and filtering purposes
"summerPromotion"
Message 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!"
Total number of recipients in the batch
12000
ISO8601 timestamp of when the batch was completed
"2021-01-01T00:00:00Z"
ISO8601 timestamp of when the batch is scheduled to be sent
"2022-01-01T00:00:00Z"
If present, batch failed validation, or had some errors during delivery. URL to a CSV file containing errors and error details of the batch
"https://example.com/errors.csv"
If present, batch was completed. URL to a CSV file containing message delivery details for each recipient.
"https://example.com/delivery.csv"
Path to first page, null if currentPage is first page
Path to prev page, null if currentPage is first page
Path to next page, null if currentPage is last page
Path to last page, null if currentPage is last page
Was this page helpful?
curl --request GET \
--url https://api.passentry.com/api/v1/batches \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": "8ecfc493-da04-493b-8b98-bf9d5cc29115",
"type": "walletMessaging",
"attributes": {
"name": "Summer Promotion 2",
"status": "failed",
"tag": null,
"content": "Hello, World!",
"scheduledAt": "2030-03-31T13:16:26Z"
}
},
{
"id": "8ecfc493-da04-493b-8b98-bf9d5cc29114",
"type": "walletMessaging",
"attributes": {
"name": "Summer Promotion",
"status": "scheduled",
"tag": null,
"content": "Hello, World!",
"scheduledAt": "2030-03-31T13:16:26Z"
}
}
],
"meta": {
"totalCount": 2,
"resultsPerPage": 25,
"currentPage": 1,
"totalPages": 1
},
"links": {
"first": null,
"prev": null,
"next": null,
"last": null
}
}