> ## Documentation Index > Fetch the complete documentation index at: https://docs.paywise.de/llms.txt > Use this file to discover all available pages before exploring further. # List debtors > List your debtors. ## OpenAPI ````yaml get /v1/debtors/ openapi: 3.0.3 info: title: paywise Case Management API version: v1 description: | Use our Case Management API to perform the debt entire collection process. Please refer to the [official docs][ref1] for more! [ref1]: https://docs.paywise.de/api-docs/case-management-api/introduction servers: - url: https://api.paywise.de description: Production environment security: [] externalDocs: url: https://docs.paywise.de/api-docs/case-management-api/ paths: /v1/debtors/: get: tags: - debtors summary: List debtors description: List your debtors. operationId: list-debtors parameters: - in: query name: acting_as schema: type: string description: Filter by acting_as value of the debtor - in: query name: id schema: type: string description: Filter by our ID of the debtor - name: limit required: false in: query description: Number of results to return per page. schema: type: integer - name: offset required: false in: query description: The initial index from which to return the results. schema: type: integer - in: query name: your_reference schema: type: string description: Filter by your_reference for the debtor responses: '200': content: application/json: schema: $ref: '#/components/schemas/PaginatedDebtorList' description: '' security: - tokenAuth: [] - tokenAuth: [] components: schemas: PaginatedDebtorList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=400&limit=100 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?offset=200&limit=100 results: type: array items: $ref: '#/components/schemas/Debtor' Debtor: type: object properties: href: type: string format: uri readOnly: true id: type: string your_reference: type: string nullable: true maxLength: 255 person: allOf: - $ref: '#/components/schemas/Person' description: >- If the debtor is a natural person or a single-person-business please provide this object. In case of a single-person-business, please set *acting_as* to *business* organization: allOf: - $ref: '#/components/schemas/Organization' description: >- If the debtor is an organization (no single-person-business), please provide this object. For single-person-business debtors see the *person* field. acting_as: description: >- Tell us if the debtor is either a consumer or a business/other organization. Single-person-business debtors must have the value *business* * `consumer` - Verbraucher * `business` - Unternehmer oneOf: - $ref: '#/components/schemas/ActingAsEnum' - $ref: '#/components/schemas/BlankEnum' addresses: type: array items: $ref: '#/components/schemas/Address' communication_channels: type: array items: $ref: '#/components/schemas/CommunicationChannel' bank_accounts: type: array items: $ref: '#/components/schemas/BankAccount' metadata: type: array items: $ref: '#/components/schemas/DebtorMetaData' events: type: array items: $ref: '#/components/schemas/DebtorEvent' created: type: string format: date-time readOnly: true updated: type: string format: date-time readOnly: true required: - acting_as - addresses - created - href - updated Person: type: object properties: salutation: type: string nullable: true maxLength: 100 first_name: type: string nullable: true maxLength: 255 last_name: type: string nullable: true maxLength: 255 birth_date: type: string format: date nullable: true death_date: type: string format: date nullable: true required: - first_name - last_name Organization: type: object properties: name: type: string nullable: true maxLength: 255 required: - name ActingAsEnum: enum: - consumer - business type: string description: |- * `consumer` - Verbraucher * `business` - Unternehmer BlankEnum: enum: - '' Address: type: object properties: street: type: string nullable: true maxLength: 255 zip: type: string nullable: true maxLength: 100 city: type: string nullable: true maxLength: 100 country: allOf: - $ref: '#/components/schemas/CountryEnum' description: |- The country, formatted as two letter ISO-3166-1 country code. * `AF` - Afghanistan * `EG` - Ägypten * `AX` - Åland-Inseln * `AL` - Albanien * `DZ` - Algerien * `AS` - Amerikanisch-Samoa * `VI` - Amerikanische Jungferninseln * `AD` - Andorra * `AO` - Angola * `AI` - Anguilla * `AQ` - Antarktis * `AG` - Antigua und Barbuda * `GQ` - Äquatorialguinea * `AR` - Argentinien * `AM` - Armenien * `AW` - Aruba * `AZ` - Aserbaidschan * `ET` - Äthiopien * `AU` - Australien * `BS` - Bahamas * `BH` - Bahrain * `BD` - Bangladesch * `BB` - Barbados * `BE` - Belgien * `BZ` - Belize * `BJ` - Benin * `BM` - Bermuda * `BT` - Bhutan * `BO` - Bolivien * `BQ` - Bonaire, Sint Eustatius und Saba * `BA` - Bosnien und Herzegowina * `BW` - Botswana * `BV` - Bouvetinsel * `BR` - Brasilien * `VG` - Britische Jungferninseln * `IO` - Britisches Territorium im Indischen Ozean * `BN` - Brunei * `BG` - Bulgarien * `BF` - Burkina Faso * `BI` - Burundi * `CL` - Chile * `CN` - China * `MP` - Commonwealth der Nördlichen Marianen * `CK` - Cookinseln * `CR` - Costa Rica * `CI` - Côte d'Ivoire * `CW` - Curaçao * `DK` - Dänemark * `DE` - Deutschland * `DM` - Dominica * `DO` - Dominikanische Republik * `DJ` - Dschibuti * `EC` - Ecuador * `SV` - El Salvador * `ER` - Eritrea * `EE` - Estland * `FK` - Falklandinseln (Malwinen) * `FO` - Faröerinseln * `FJ` - Fidschi * `FI` - Finnland * `FR` - Frankreich * `GF` - Französisch Guinea * `PF` - Französisch-Polynesien * `TF` - Französische Süd- und Antarktisgebiete * `GA` - Gabun * `GM` - Gambia * `GE` - Georgien * `GH` - Ghana * `GI` - Gibraltar * `GD` - Granada * `GR` - Griechenland * `GL` - Grönland * `GP` - Guadeloupe * `GU` - Guam * `GT` - Guatemala * `GG` - Guernsey * `GN` - Guinea * `GW` - Guinea-Bissau * `GY` - Guyana * `HT` - Haiti * `HM` - Heard und McDonaldinseln * `HN` - Honduras * `HK` - Hong Kong * `IN` - Indien * `ID` - Indonesien * `IQ` - Irak * `IR` - Iran (Islamische Republik) * `IE` - Irland * `IS` - Island * `IM` - Isle of Man * `IL` - Israel * `IT` - Italien * `JM` - Jamaika * `JP` - Japan * `YE` - Jemen * `JE` - Jersey * `JO` - Jordanien * `KY` - Kaimaninseln * `KH` - Kambodscha * `CM` - Kamerun * `CA` - Kanada * `CV` - Kap Verde * `KZ` - Kasachstan * `QA` - Katar * `KE` - Kenia * `KG` - Kirgisistan * `KI` - Kirivati * `CC` - Kokosinseln (Keelinginseln) * `CO` - Kolumbien * `KM` - Komoren * `CG` - Kongo * `CD` - Kongo (Demokratische Republik) * `HR` - Kroatien * `CU` - Kuba * `KW` - Kuwait * `LA` - Laos, Demokratische Volksrepublik * `LS` - Lesotho * `LV` - Lettland * `LB` - Libanon * `LR` - Liberia * `LY` - Libyen * `LI` - Liechtenstein * `LT` - Litauen * `LU` - Luxemburg * `MO` - Macao * `MG` - Madagaskar * `MW` - Malawi * `MY` - Malaysia * `MV` - Malediven * `ML` - Mali * `MT` - Malta * `MA` - Marokko * `MH` - Marshallinseln * `MQ` - Martinique * `MR` - Mauretanien * `MU` - Mauritius * `YT` - Mayotte * `MK` - Mazedonien * `MX` - Mexiko * `FM` - Mikronesien (Föderierte Staaten von) * `MD` - Moldawien * `MC` - Monaco * `MN` - Mongolei * `ME` - Montenegro * `MS` - Montserrat * `MZ` - Mozambique * `MM` - Myanmar * `NA` - Namibia * `NR` - Nauru * `NP` - Nepal * `NC` - Neukaledonien * `NZ` - Neuseeland * `NI` - Nicaragua * `NL` - Niederlande * `NE` - Niger * `NG` - Nigeria * `NU` - Niue * `KP` - Nordkorea * `NF` - Norfolkinsel * `NO` - Norwegen * `OM` - Oman * `AT` - Österreich * `TL` - Osttimor * `PK` - Pakistan * `PS` - Palästina * `PW` - Palau * `PA` - Panama * `PG` - Papua Neu Guinea * `PY` - Paraguay * `PE` - Peru * `PH` - Philippinen * `PN` - Pitcairn * `PL` - Polen * `PT` - Portugal * `PR` - Puerto Rico * `RE` - Réunion * `RW` - Ruanda * `RO` - Rumänien * `RU` - Russland * `BL` - Saint-Barthélemy * `PM` - Saint-Pierre und Miquelon * `SB` - Salomonen * `ZM` - Sambia * `WS` - Samoa * `SM` - San Marino * `ST` - São Tomé und Príncipe * `SA` - Saudi Arabien * `SE` - Schweden * `CH` - Schweiz * `SN` - Senegal * `RS` - Serbien * `SC` - Seychellen * `SL` - Sierra Leone * `ZW` - Simbabwe * `SG` - Singapur * `SX` - Sint Maarten (niederländischer Teil) * `SK` - Slowakei * `SI` - Slowenien * `SO` - Somalia * `ES` - Spanien * `SJ` - Spitzbergen und Jan Mayen * `LK` - Sri Lanka * `SH` - St. Helena, Ascension und Tristan da Cunha * `KN` - St. Kitts und Nevis * `LC` - St. Lucia * `MF` - St. Martin (französischer Teil) * `VC` - St. Vincent und die Grenadinen * `ZA` - Südafrika * `SD` - Sudan * `GS` - Südgeorgien und die Südlichen Sandwichinseln * `KR` - Südkorea * `SS` - Südsudan * `SR` - Surinam * `SZ` - Swasiland * `SY` - Syrien * `TJ` - Tadschikistan * `TW` - Taiwan (Provinz Chinas) * `TZ` - Tansania * `TH` - Thailand * `TG` - Togo * `TK` - Tokelau * `TO` - Tonga * `TT` - Trinidad und Tobago * `TD` - Tschad * `CZ` - Tschechien * `TN` - Tunesien * `TR` - Türkei * `TM` - Turkmenistan * `TC` - Turks- und Caicosinseln * `TV` - Tuvalu * `UM` - USA - Sonstige Kleine Inseln * `UG` - Uganda * `UA` - Ukraine * `HU` - Ungarn * `UY` - Uruguay * `UZ` - Usbekistan * `VU` - Vanuatu * `VA` - Vatikanstadt * `VE` - Venezuela (Bolivarische Republik) * `AE` - Vereinigte Arabische Emirate * `US` - Vereinigte Staaten von Amerika * `GB` - Vereinigtes Königreich * `VN` - Vietnam * `WF` - Wallis und Futuna * `CX` - Weihnachtsinsel * `BY` - Weißrussland * `EH` - Westsahara * `CF` - Zentralafrikanische Republik * `CY` - Zypern required: - city - country - street - zip CommunicationChannel: type: object properties: type: $ref: '#/components/schemas/CommunicationChannelTypeEnum' value: type: string maxLength: 255 required: - type - value BankAccount: type: object properties: iban: type: string maxLength: 34 bic: type: string nullable: true maxLength: 255 required: - iban DebtorMetaData: type: object description: Metadata for debtors properties: type: $ref: '#/components/schemas/DebtorMetaDataTypeEnum' value: type: string maxLength: 255 required: - type - value DebtorEvent: type: object description: Base class for events. Subclassed by other serializers. properties: type: $ref: '#/components/schemas/DebtorEventTypeEnum' title: type: string maxLength: 255 occurence: type: string format: date-time your_reference: type: string nullable: true maxLength: 255 description: type: string nullable: true maxLength: 255 location: type: string nullable: true maxLength: 255 required: - occurence - title - type CountryEnum: enum: - AF - EG - AX - AL - DZ - AS - VI - AD - AO - AI - AQ - AG - GQ - AR - AM - AW - AZ - ET - AU - BS - BH - BD - BB - BE - BZ - BJ - BM - BT - BO - BQ - BA - BW - BV - BR - VG - IO - BN - BG - BF - BI - CL - CN - MP - CK - CR - CI - CW - DK - DE - DM - DO - DJ - EC - SV - ER - EE - FK - FO - FJ - FI - FR - GF - PF - TF - GA - GM - GE - GH - GI - GD - GR - GL - GP - GU - GT - GG - GN - GW - GY - HT - HM - HN - HK - IN - ID - IQ - IR - IE - IS - IM - IL - IT - JM - JP - YE - JE - JO - KY - KH - CM - CA - CV - KZ - QA - KE - KG - KI - CC - CO - KM - CG - CD - HR - CU - KW - LA - LS - LV - LB - LR - LY - LI - LT - LU - MO - MG - MW - MY - MV - ML - MT - MA - MH - MQ - MR - MU - YT - MK - MX - FM - MD - MC - MN - ME - MS - MZ - MM - NA - NR - NP - NC - NZ - NI - NL - NE - NG - NU - KP - NF - 'NO' - OM - AT - TL - PK - PS - PW - PA - PG - PY - PE - PH - PN - PL - PT - PR - RE - RW - RO - RU - BL - PM - SB - ZM - WS - SM - ST - SA - SE - CH - SN - RS - SC - SL - ZW - SG - SX - SK - SI - SO - ES - SJ - LK - SH - KN - LC - MF - VC - ZA - SD - GS - KR - SS - SR - SZ - SY - TJ - TW - TZ - TH - TG - TK - TO - TT - TD - CZ - TN - TR - TM - TC - TV - UM - UG - UA - HU - UY - UZ - VU - VA - VE - AE - US - GB - VN - WF - CX - BY - EH - CF - CY type: string description: |- * `AF` - Afghanistan * `EG` - Ägypten * `AX` - Åland-Inseln * `AL` - Albanien * `DZ` - Algerien * `AS` - Amerikanisch-Samoa * `VI` - Amerikanische Jungferninseln * `AD` - Andorra * `AO` - Angola * `AI` - Anguilla * `AQ` - Antarktis * `AG` - Antigua und Barbuda * `GQ` - Äquatorialguinea * `AR` - Argentinien * `AM` - Armenien * `AW` - Aruba * `AZ` - Aserbaidschan * `ET` - Äthiopien * `AU` - Australien * `BS` - Bahamas * `BH` - Bahrain * `BD` - Bangladesch * `BB` - Barbados * `BE` - Belgien * `BZ` - Belize * `BJ` - Benin * `BM` - Bermuda * `BT` - Bhutan * `BO` - Bolivien * `BQ` - Bonaire, Sint Eustatius und Saba * `BA` - Bosnien und Herzegowina * `BW` - Botswana * `BV` - Bouvetinsel * `BR` - Brasilien * `VG` - Britische Jungferninseln * `IO` - Britisches Territorium im Indischen Ozean * `BN` - Brunei * `BG` - Bulgarien * `BF` - Burkina Faso * `BI` - Burundi * `CL` - Chile * `CN` - China * `MP` - Commonwealth der Nördlichen Marianen * `CK` - Cookinseln * `CR` - Costa Rica * `CI` - Côte d'Ivoire * `CW` - Curaçao * `DK` - Dänemark * `DE` - Deutschland * `DM` - Dominica * `DO` - Dominikanische Republik * `DJ` - Dschibuti * `EC` - Ecuador * `SV` - El Salvador * `ER` - Eritrea * `EE` - Estland * `FK` - Falklandinseln (Malwinen) * `FO` - Faröerinseln * `FJ` - Fidschi * `FI` - Finnland * `FR` - Frankreich * `GF` - Französisch Guinea * `PF` - Französisch-Polynesien * `TF` - Französische Süd- und Antarktisgebiete * `GA` - Gabun * `GM` - Gambia * `GE` - Georgien * `GH` - Ghana * `GI` - Gibraltar * `GD` - Granada * `GR` - Griechenland * `GL` - Grönland * `GP` - Guadeloupe * `GU` - Guam * `GT` - Guatemala * `GG` - Guernsey * `GN` - Guinea * `GW` - Guinea-Bissau * `GY` - Guyana * `HT` - Haiti * `HM` - Heard und McDonaldinseln * `HN` - Honduras * `HK` - Hong Kong * `IN` - Indien * `ID` - Indonesien * `IQ` - Irak * `IR` - Iran (Islamische Republik) * `IE` - Irland * `IS` - Island * `IM` - Isle of Man * `IL` - Israel * `IT` - Italien * `JM` - Jamaika * `JP` - Japan * `YE` - Jemen * `JE` - Jersey * `JO` - Jordanien * `KY` - Kaimaninseln * `KH` - Kambodscha * `CM` - Kamerun * `CA` - Kanada * `CV` - Kap Verde * `KZ` - Kasachstan * `QA` - Katar * `KE` - Kenia * `KG` - Kirgisistan * `KI` - Kirivati * `CC` - Kokosinseln (Keelinginseln) * `CO` - Kolumbien * `KM` - Komoren * `CG` - Kongo * `CD` - Kongo (Demokratische Republik) * `HR` - Kroatien * `CU` - Kuba * `KW` - Kuwait * `LA` - Laos, Demokratische Volksrepublik * `LS` - Lesotho * `LV` - Lettland * `LB` - Libanon * `LR` - Liberia * `LY` - Libyen * `LI` - Liechtenstein * `LT` - Litauen * `LU` - Luxemburg * `MO` - Macao * `MG` - Madagaskar * `MW` - Malawi * `MY` - Malaysia * `MV` - Malediven * `ML` - Mali * `MT` - Malta * `MA` - Marokko * `MH` - Marshallinseln * `MQ` - Martinique * `MR` - Mauretanien * `MU` - Mauritius * `YT` - Mayotte * `MK` - Mazedonien * `MX` - Mexiko * `FM` - Mikronesien (Föderierte Staaten von) * `MD` - Moldawien * `MC` - Monaco * `MN` - Mongolei * `ME` - Montenegro * `MS` - Montserrat * `MZ` - Mozambique * `MM` - Myanmar * `NA` - Namibia * `NR` - Nauru * `NP` - Nepal * `NC` - Neukaledonien * `NZ` - Neuseeland * `NI` - Nicaragua * `NL` - Niederlande * `NE` - Niger * `NG` - Nigeria * `NU` - Niue * `KP` - Nordkorea * `NF` - Norfolkinsel * `NO` - Norwegen * `OM` - Oman * `AT` - Österreich * `TL` - Osttimor * `PK` - Pakistan * `PS` - Palästina * `PW` - Palau * `PA` - Panama * `PG` - Papua Neu Guinea * `PY` - Paraguay * `PE` - Peru * `PH` - Philippinen * `PN` - Pitcairn * `PL` - Polen * `PT` - Portugal * `PR` - Puerto Rico * `RE` - Réunion * `RW` - Ruanda * `RO` - Rumänien * `RU` - Russland * `BL` - Saint-Barthélemy * `PM` - Saint-Pierre und Miquelon * `SB` - Salomonen * `ZM` - Sambia * `WS` - Samoa * `SM` - San Marino * `ST` - São Tomé und Príncipe * `SA` - Saudi Arabien * `SE` - Schweden * `CH` - Schweiz * `SN` - Senegal * `RS` - Serbien * `SC` - Seychellen * `SL` - Sierra Leone * `ZW` - Simbabwe * `SG` - Singapur * `SX` - Sint Maarten (niederländischer Teil) * `SK` - Slowakei * `SI` - Slowenien * `SO` - Somalia * `ES` - Spanien * `SJ` - Spitzbergen und Jan Mayen * `LK` - Sri Lanka * `SH` - St. Helena, Ascension und Tristan da Cunha * `KN` - St. Kitts und Nevis * `LC` - St. Lucia * `MF` - St. Martin (französischer Teil) * `VC` - St. Vincent und die Grenadinen * `ZA` - Südafrika * `SD` - Sudan * `GS` - Südgeorgien und die Südlichen Sandwichinseln * `KR` - Südkorea * `SS` - Südsudan * `SR` - Surinam * `SZ` - Swasiland * `SY` - Syrien * `TJ` - Tadschikistan * `TW` - Taiwan (Provinz Chinas) * `TZ` - Tansania * `TH` - Thailand * `TG` - Togo * `TK` - Tokelau * `TO` - Tonga * `TT` - Trinidad und Tobago * `TD` - Tschad * `CZ` - Tschechien * `TN` - Tunesien * `TR` - Türkei * `TM` - Turkmenistan * `TC` - Turks- und Caicosinseln * `TV` - Tuvalu * `UM` - USA - Sonstige Kleine Inseln * `UG` - Uganda * `UA` - Ukraine * `HU` - Ungarn * `UY` - Uruguay * `UZ` - Usbekistan * `VU` - Vanuatu * `VA` - Vatikanstadt * `VE` - Venezuela (Bolivarische Republik) * `AE` - Vereinigte Arabische Emirate * `US` - Vereinigte Staaten von Amerika * `GB` - Vereinigtes Königreich * `VN` - Vietnam * `WF` - Wallis und Futuna * `CX` - Weihnachtsinsel * `BY` - Weißrussland * `EH` - Westsahara * `CF` - Zentralafrikanische Republik * `CY` - Zypern CommunicationChannelTypeEnum: enum: - email - phone - mobile_phone - fax - skype - facebook_messenger - imessage - whatsapp - facebook - twitter - linkedin - xing - social_various - website_url - web_various type: string description: |- * `email` - E-Mail * `phone` - Telefon * `mobile_phone` - Mobiltelefon * `fax` - Fax * `skype` - Skype * `facebook_messenger` - Facebook Messenger * `imessage` - iMessage * `whatsapp` - WhatAapp * `facebook` - Facebook * `twitter` - Twitter * `linkedin` - Linkedin * `xing` - Xing * `social_various` - Anderes Social Medium * `website_url` - Website URL * `web_various` - Andere Web-Quelle DebtorMetaDataTypeEnum: enum: - user:reference - user:name - user:ip - user:language type: string description: |- * `user:reference` - user:reference * `user:name` - user:name * `user:ip` - user:ip * `user:language` - user:language DebtorEventTypeEnum: enum: - registration - login - insolvency type: string description: |- * `registration` - Registrierung * `login` - Login * `insolvency` - Insolvenz securitySchemes: tokenAuth: type: http scheme: bearer ````