List Batches

get
Responses
200
OK
application/json
get
GET /public/v1/notifications/batches HTTP/1.1
Host: 
Accept: */*
{
  "$meta": {
    "pagination": {
      "offset": 1,
      "limit": 1,
      "total": 1
    },
    "omitted": [
      "text"
    ]
  },
  "data": [
    {
      "id": "text",
      "audit": {
        "created": {
          "0": "[",
          "1": "C",
          "2": "i",
          "3": "r",
          "4": "c",
          "5": "u",
          "6": "l",
          "7": "a",
          "8": "r",
          "9": " ",
          "10": "R",
          "11": "e",
          "12": "f",
          "13": "e",
          "14": "r",
          "15": "e",
          "16": "n",
          "17": "c",
          "18": "e",
          "19": "]"
        },
        "updated": {
          "0": "[",
          "1": "C",
          "2": "i",
          "3": "r",
          "4": "c",
          "5": "u",
          "6": "l",
          "7": "a",
          "8": "r",
          "9": " ",
          "10": "R",
          "11": "e",
          "12": "f",
          "13": "e",
          "14": "r",
          "15": "e",
          "16": "n",
          "17": "c",
          "18": "e",
          "19": "]"
        }
      },
      "$meta": {
        "omitted": [
          "text"
        ]
      },
      "category": {
        "id": "text",
        "audit": {
          "0": "[",
          "1": "C",
          "2": "i",
          "3": "r",
          "4": "c",
          "5": "u",
          "6": "l",
          "7": "a",
          "8": "r",
          "9": " ",
          "10": "R",
          "11": "e",
          "12": "f",
          "13": "e",
          "14": "r",
          "15": "e",
          "16": "n",
          "17": "c",
          "18": "e",
          "19": "]"
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "description": "text",
        "optOutAllowed": true,
        "shortDescription": "text",
        "status": "text",
        "name": "text",
        "note": "text",
        "deleteAllowed": true,
        "icon": "text",
        "statistics": {
          "month": {
            "bounced": 1,
            "complained": 1,
            "discarded": 1,
            "failed": 1,
            "sent": 1,
            "total": 1
          },
          "today": {
            "bounced": 1,
            "complained": 1,
            "discarded": 1,
            "failed": 1,
            "sent": 1,
            "total": 1
          },
          "week": {
            "bounced": 1,
            "complained": 1,
            "discarded": 1,
            "failed": 1,
            "sent": 1,
            "total": 1
          }
        },
        "lastUsed": "2025-06-22T10:41:13.641Z"
      },
      "account": {
        "id": "text",
        "audit": {
          "0": "[",
          "1": "C",
          "2": "i",
          "3": "r",
          "4": "c",
          "5": "u",
          "6": "l",
          "7": "a",
          "8": "r",
          "9": " ",
          "10": "R",
          "11": "e",
          "12": "f",
          "13": "e",
          "14": "r",
          "15": "e",
          "16": "n",
          "17": "c",
          "18": "e",
          "19": "]"
        },
        "$meta": {
          "omitted": [
            "text"
          ]
        },
        "icon": "text",
        "externalIds": {
          "pyraTenantId": "123e4567-e89b-12d3-a456-426614174000"
        },
        "externalId": "text",
        "externalName": "text",
        "type": "text",
        "status": "text",
        "serviceLevel": "text",
        "address": {
          "addressLine1": "text",
          "addressLine2": "text",
          "postCode": "text",
          "city": "text",
          "state": "text",
          "country": "text"
        },
        "technicalSupportEmail": "[email protected]",
        "website": "text",
        "description": "text",
        "name": "text",
        "groups": [
          {
            "id": "text",
            "name": "text",
            "description": "text",
            "logo": "text",
            "isDefault": true
          }
        ],
        "eligibility": {
          "client": true,
          "partner": true
        }
      },
      "subject": "text",
      "body": "text",
      "attachments": [
        {
          "id": "text",
          "audit": {
            "0": "[",
            "1": "C",
            "2": "i",
            "3": "r",
            "4": "c",
            "5": "u",
            "6": "l",
            "7": "a",
            "8": "r",
            "9": " ",
            "10": "R",
            "11": "e",
            "12": "f",
            "13": "e",
            "14": "r",
            "15": "e",
            "16": "n",
            "17": "c",
            "18": "e",
            "19": "]"
          },
          "$meta": {
            "omitted": [
              "text"
            ]
          },
          "name": "text",
          "type": "text",
          "description": "text",
          "filename": "text",
          "size": 1,
          "contentType": "text",
          "request": {
            "0": "[",
            "1": "C",
            "2": "i",
            "3": "r",
            "4": "c",
            "5": "u",
            "6": "l",
            "7": "a",
            "8": "r",
            "9": " ",
            "10": "R",
            "11": "e",
            "12": "f",
            "13": "e",
            "14": "r",
            "15": "e",
            "16": "n",
            "17": "c",
            "18": "e",
            "19": "]"
          }
        }
      ]
    }
  ]
}

Last updated

Was this helpful?