List organizations

Beta

GET

/v2/organizations

GET

/api/v2/organizations

curl -G https://api-sandbox.payabli.com/api/v2/organizations \
     -H "Authorization: Bearer <token>" \
     -d businessReference=6e2b9d14-7a3c-4f58-b1e6-0c9d3a5f8e27

{
  "success": true,
  "message": "Organizations retrieved successfully",
  "traceId": "0HNPE4LGV825H:00000033",
  "data": {
    "items": [
      {
        "paypointReference": "a8806f02-23b3-4f6d-bba3-42e1b94326ea",
        "parentPaypointReference": "3c7f1a9e-5d2b-4e84-a6c0-8b1f4d7e2a95",
        "paypointStatus": "pending",
        "entryName": "8cfec329267",
        "createdAt": "2026-10-20T22:20:37.029589",
        "updatedAt": "2026-10-20T22:20:37.029589",
        "_links": {
          "self": "/v2/organizations/a8806f02-23b3-4f6d-bba3-42e1b94326ea",
          "business": "/v2/businesses/6e2b9d14-7a3c-4f58-b1e6-0c9d3a5f8e27"
        },
        "businessReference": "6e2b9d14-7a3c-4f58-b1e6-0c9d3a5f8e27",
        "paypointType": "organization",
        "doingBusinessAs": "PropertyManager Pro",
        "description": "Property management software partner",
        "website": "https://example.com",
        "timezone": "America/New_York",
        "externalId": "pmp-org-001"
      }
    ],
    "total": 1,
    "page": 1,
    "pageSize": 25
  }
}

Lists organizations with optional filtering and pagination. Only organizations are returned. Other paypoints never appear in this list.

Authentication

AuthorizationBearer

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

Query parameters

businessReferencestringOptional

Filter by the business the organization belongs to.

statusstringOptional

Filter by organization status. One of active, inactive, suspended, or closed. Any other value returns 400.

searchstringOptional

Free-text search across organizations.

limitintegerOptional

Number of results per page.

pageintegerOptional

Page number to return.

Response

A page of organizations.

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 paypoints.

Errors

400

Bad Request Error

401

Unauthorized Error

500

Internal Server Error