---
title: "Register Creditors"
method: GET
path: "/v1/matters/{matter_id}/creditors/register"
tags: ["creditors"]
---

# Register Creditors

`GET /v1/matters/{matter_id}/creditors/register`

## Request

- Base URL: `https://api.ender.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.ender.au/v1/matters/{matter_id}/creditors/register`
- Auth: HTTP bearer

## Path parameters

- `matter_id` string, uuid, required

## Query parameters

- `relationship` 'all' | 'not_related' | 'related' | 'unknown'
- `sort` string
- `limit` integer
- `cursor` string, nullable

## Response `200`

Successful Response

- CreditorRegisterQueryPage
  - `contract` 'creditors.register.v2', required
  - `snapshot_id` string, required
  - `workspace_id` string, uuid, required
  - `matter_id` string, uuid, required
  - `capabilities` CreditorRegisterCapabilitiesV2, required
    - `repository_folder` boolean, required
    - `xero_import` boolean, required
    - `portal` false, required
  - `summary` CreditorRegisterSummaryV2, required
    - `total_creditors` integer, required
    - `confirmed_creditors` integer, required
    - `candidate_creditors` integer, required
    - `needs_attention` integer, required
    - `pod_evidence_creditors` integer, required
    - `currencies` CreditorRegisterCurrencySummaryV2[], required
      - `currency` string, required
      - `book_balance` string, decimal, required
      - `pod_claimed` string, decimal, required
  - `rows` CreditorRegisterRowV2[], required
    - `creditor_id` string, uuid, required
    - `creditor` string, required
    - `profile_state` 'candidate' | 'confirmed', required
    - `creditor_class` 'priority' | 'secured' | 'unsecured' | 'employee', required
    - `relationship_status` 'unknown' | 'not_related' | 'related', required
    - `email` RegisterContactV2, required
      - `value` string, nullable, required
      - `conflict` boolean, required
    - `phone` RegisterContactV2, required
      - `value` string, nullable, required
      - `conflict` boolean, required
    - `postal_address` RegisterContactV2, required
      - `value` string, nullable, required
      - `conflict` boolean, required
    - `contact_name` RegisterContactV2, required
      - `value` string, nullable, required
      - `conflict` boolean, required
    - `book_balances` RegisterMoneyV2[], required
      - `currency` string, required
      - `amount` string, decimal, required
    - `rocap_amounts` RegisterMoneyV2[], required
      - `currency` string, required
      - `amount` string, decimal, required
    - `pod_claimed` RegisterMoneyV2[], required
      - `currency` string, required
      - `amount` string, decimal, required
    - `admitted_for_voting` RegisterMoneyV2[], required
      - `currency` string, required
      - `amount` string, decimal, required
    - `admitted_for_dividend` RegisterMoneyV2[], required
      - `currency` string, required
      - `amount` string, decimal, required
    - `latest_claim_status` 'draft' | 'lodged' | 'awaiting_information' | 'partly_admitted' | 'admitted' | 'rejected' | 'withdrawn', required
    - `claim_statuses` ClaimStatus[], required
    - `claim_classes` string[], required
    - `evidence_state` 'missing' | 'pending_indexing' | 'indexed' | 'needs_attention', required
    - `evidence_count` integer, required
    - `attention` RegisterAttentionReason[], required
    - `abn` string, nullable, required
    - `acn` string, nullable, required
    - `source_kinds` SourceKind[], required
    - `claim_count` integer, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
    - `admissions` RegisterAdmissionV2[], required
      - `claim_id` string, uuid, required
      - `revision_id` string, uuid, required
      - `recorded_at` string, date-time, required
      - `status` 'draft' | 'lodged' | 'awaiting_information' | 'partly_admitted' | 'admitted' | 'rejected' | 'withdrawn', required
      - `currency` string, required
      - `claimed` string, decimal, required
      - `admitted_for_dividend` string, decimal, nullable, required
  - `next_cursor` string, nullable, required
  - `totals` CreditorRegisterTotals, required
    - `creditor_count` integer, required
    - `claim_count` integer, required
    - `group_counts` CreditorRegisterGroupCounts, required: Creditors in each register group, every group counted.
      - `priority` integer, required
      - `secured` integer, required
      - `unsecured` integer, required
    - `book_balances` RegisterMoneyV2[], required
      - `currency` string, required
      - `amount` string, decimal, required
    - `rocap_amounts` RegisterMoneyV2[], required
      - `currency` string, required
      - `amount` string, decimal, required
    - `pod_claimed` RegisterMoneyV2[], required
      - `currency` string, required
      - `amount` string, decimal, required
    - `admitted_for_dividend` RegisterMoneyV2[], required
      - `currency` string, required
      - `amount` string, decimal, required
    - `admitted_for_voting` RegisterMoneyV2[], required
      - `currency` string, required
      - `amount` string, decimal, required
  - `review_order` string[], required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/ender/apis/ender-backend.md) - [All operations](https://skmtc.dev/ender/apis/ender-backend/llms.txt) - [OpenAPI document](https://skmtc.dev/ender/apis/ender-backend/revisions/bf4373130521?raw)