List Batches - PassEntry

GET

api

batches

List 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

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

page

integer

Page number

perPage

integer

Number of items per page

type

enum<string>

Type of the batch

Available options:

walletMessaging,

passCreation,

passUpdate

Response

Successful

data

object[]

Show child attributes

links

object

Show child attributes

meta

object

Show child attributes

Cancel BatchCancel a Batch. Can only be used on scheduled batches.

⌘I

List 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
  }
}