GET
/
v1
/
debtors
curl --request GET \
  --url https://api.paywise.de/v1/debtors/ \
  --header 'Authorization: Bearer <token>'
{
  "count": 123,
  "next": "http://api.example.org/accounts/?offset=400&limit=100",
  "previous": "http://api.example.org/accounts/?offset=200&limit=100",
  "results": [
    {
      "href": "<string>",
      "id": "<string>",
      "your_reference": "<string>",
      "person": {
        "salutation": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "birth_date": "2023-12-25",
        "death_date": "2023-12-25"
      },
      "organization": {
        "name": "<string>"
      },
      "acting_as": "consumer",
      "addresses": [
        {
          "street": "<string>",
          "zip": "<string>",
          "city": "<string>",
          "country": "AF"
        }
      ],
      "communication_channels": [
        {
          "type": "email",
          "value": "<string>"
        }
      ],
      "bank_accounts": [
        {
          "iban": "<string>",
          "bic": "<string>"
        }
      ],
      "metadata": [
        {
          "type": "user:reference",
          "value": "<string>"
        }
      ],
      "events": [
        {
          "type": "registration",
          "title": "<string>",
          "occurence": "2023-11-07T05:31:56Z",
          "your_reference": "<string>",
          "description": "<string>",
          "location": "<string>"
        }
      ],
      "created": "2023-11-07T05:31:56Z",
      "updated": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
acting_as
string

Filter by acting_as value of the debtor

​
id
string

Filter by our ID of the debtor

​
limit
integer

Number of results to return per page.

​
offset
integer

The initial index from which to return the results.

​
your_reference
string

Filter by your_reference for the debtor

Response

200 - application/json
​
count
integer
Example:

123

​
next
string | null
Example:

"http://api.example.org/accounts/?offset=400&limit=100"

​
previous
string | null
Example:

"http://api.example.org/accounts/?offset=200&limit=100"

​
results
object[]