API Reference
These docs are for v2.3. Click to read the latest docs for v3.0.

Retrieves active Arrangements via pagination

Sample Request:
GET /api/v2.0/arrangements/getarrangements?status=Failed

MAX PER PAGE LIMIT: 100

Sample Response:
{
  "page": 1,
  "total": 2,
  "limit": 25,
  "totalEntries": 27,
  "data": [
      {
          "arragementState": "Failed",
          "accountReference": "ALB10-001-GA",
          "occupancyReference": "ALB10-001",
          "arrangementStart": "03/12/2021 00:00",
          "arrangementEnd": "11/05/2022 00:00",
          "numberOfInstallments": 20
      },
      ...
      ...
  ]
}         
Language
Credentials
Header
URL
Click Try It! to start a request and see the response here!