List applications

{
  "success": true,
  "message": "Applications retrieved successfully",
  "traceId": "0HNNNPRPLVN3G:00000004",
  "data": {
    "data": [
      {
        "requestsReference": "3f3caa7b-bdfe-4bf1-814b-30d54859247c",
        "businessReference": "019fed1a-3d6e-75d3-a81e-cba3874b0a55",
        "applicationStatus": "draft",
        "applicationStatusCode": 1,
        "allowedActions": [
          "submit",
          "withdraw",
          "abandon"
        ],
        "createdAt": "2026-07-01T15:00:01.734346",
        "_links": {
          "self": "/v2/requests/3f3caa7b-bdfe-4bf1-814b-30d54859247c",
          "business": "/v2/businesses/019fed1a-3d6e-75d3-a81e-cba3874b0a55"
        },
        "paypointName": "Rose Gardens",
        "paypointLegalName": "Rose Gardens LLC",
        "ein": "****8993",
        "primaryOwnerName": "Marcus Delgado",
        "primaryOwnerReference": "01a0014d-ce1a-7110-9bac-c4c59647a88d",
        "externalId": "APP-2025-0417",
        "parent": "a8806f02-23b3-4f6d-bba3-42e1b94326ea",
        "parentOrgName": "PropertyManager Pro",
        "tags": [
          "priority"
        ]
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 20
  }
}

Lists boarding applications with pagination.

Authentication

AuthorizationBearer

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

Query parameters

pageintegerOptionalDefaults to 1

The page number to return, starting at 1.

limitintegerOptionalDefaults to 20

The number of applications per page.

Response

A page of applications.

successboolean

Whether the request succeeded.

messagestring or null

A human-readable result message.

traceIdstring or null

The trace identifier for the request, useful for support.

dataobject or null

The page of applications.

Errors

401

Unauthorized Error

500

Internal Server Error