Skip to content
Basenet
🇳🇱 Nederlands
🇳🇱 Nederlands🇬🇧 English
Esc
↑↓navigate↵open⌘Jpreview

List matters (scope matters:read)

GET/api/v1/matters
Authorization
AuthorizationBearer token · headerrequired

Scoped API token (bnx_…). Required scopes are noted per operation.

Query parameters
$topinteger

Page size ($top, max 200).

min 1 · max 200
$skipinteger

Offset ($skip).

min 0
Responses
200

Paginated list

itemsobject[]required
Show properties
Array of object
idstringrequired
numberstringrequired
namestringrequired
statusstringrequired
flavorstringrequired
practiceAreastring | nullrequired
departmentIdstring | nullrequired
accessLevelIdstring | nullrequired
solicitorResponsibleRelationIdstring | nullrequired
startDatestring | nullrequired
closedDatestring | nullrequired
createdAtstringrequired
updatedAtstringrequired
legalAidobject
Show properties
presentbooleanrequired
stagestringrequired
Allowed:nonerequestedassigned
hourlyFromstring | nullrequired
continuesAsHoursMatterbooleanrequired

Deprecated: derived as hourlyFrom !== null. Prefer hourlyFrom for the dated switch.

filterstringrequired
Allowed:yesnohours
totalintegerrequired
skipintegerrequired
topintegerrequired
401

Unauthenticated

errorstringrequired
codestringrequired
rulestring
403

Forbidden (missing scope or permission)

errorstringrequired
codestringrequired
rulestring
429

Rate limited

errorstringrequired
codestringrequired
rulestring
Request
curl -X GET '/api/v1/matters' \
  -H 'Authorization: Bearer YOUR_TOKEN'
Response
{
  "items": [
    {
      "id": "string",
      "number": "string",
      "name": "string",
      "status": "string",
      "flavor": "string",
      "practiceArea": "string",
      "departmentId": "string",
      "accessLevelId": "string",
      "solicitorResponsibleRelationId": "string",
      "startDate": "string",
      "closedDate": "string",
      "createdAt": "string",
      "updatedAt": "string",
      "legalAid": {
        "present": true,
        "stage": "none",
        "hourlyFrom": "string",
        "continuesAsHoursMatter": true,
        "filter": "yes"
      }
    }
  ],
  "total": 0,
  "skip": 0,
  "top": 0
}