> For the complete documentation index, see [llms.txt](https://docs.moderncollections.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.moderncollections.io/rest-api-explorer/debtors.md).
# Debtors
Look up the debtor entities behind placements. Each debtor may carry multiple placements over time.
## List debtors
> Returns a paginated list of debtors associated with your creditor account.
```json
{"openapi":"3.1.0","info":{"title":"Modern Collections API","version":"1.0.0"},"tags":[{"name":"debtors","description":"Look up the debtor entities behind placements. Each debtor may carry multiple placements over time."}],"servers":[{"url":"https://api.moderncollections.io/v1","description":"Production"},{"url":"https://sandbox.api.moderncollections.io/v1","description":"Sandbox"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Pass your API key as a Bearer token in the `Authorization` header."}},"parameters":{"Page":{"name":"page","in":"query","schema":{"type":"integer","minimum":1,"default":1}},"PageSize":{"name":"page_size","in":"query","schema":{"type":"integer","minimum":1,"maximum":100,"default":25}}},"schemas":{"DebtorList":{"type":"object","properties":{"data":{"type":"array","items":{"$ref":"#/components/schemas/Debtor"}},"pagination":{"$ref":"#/components/schemas/Pagination"}}},"Debtor":{"allOf":[{"$ref":"#/components/schemas/NewDebtor"},{"type":"object","properties":{"debtor_id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"placement_count":{"type":"integer"},"flags":{"type":"object","properties":{"cease_and_desist":{"type":"boolean"},"attorney_representation":{"type":"boolean"},"bankruptcy_filed":{"type":"boolean"}}}}}]},"NewDebtor":{"type":"object","required":["company_name","state"],"properties":{"company_name":{"type":"string"},"primary_domain":{"type":"string"},"primary_email":{"type":"string","format":"email"},"primary_phone":{"type":"string"},"state":{"type":"string","description":"Two-letter US state code."},"city":{"type":"string"},"zip":{"type":"string"},"entity_type":{"type":"string","enum":["corp","llc","sole_prop","partnership","other"]}}},"Pagination":{"type":"object","properties":{"page":{"type":"integer"},"page_size":{"type":"integer"},"total_count":{"type":"integer"},"total_pages":{"type":"integer"}}},"ErrorEnvelope":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Error"}}},"Error":{"type":"object","required":["code","category","message"],"properties":{"code":{"type":"string"},"category":{"type":"string","enum":["invalid_request","authentication","authorization","not_found","conflict","compliance_refusal","rate_limit","server_error"]},"message":{"type":"string"},"request_id":{"type":"string"}}}},"responses":{"Unauthorized":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}},"paths":{"/debtors":{"get":{"summary":"List debtors","description":"Returns a paginated list of debtors associated with your creditor account.","tags":["debtors"],"operationId":"listDebtors","parameters":[{"$ref":"#/components/parameters/Page"},{"$ref":"#/components/parameters/PageSize"},{"name":"q","in":"query","description":"Full-text search across `company_name` and `primary_domain`.","schema":{"type":"string"}}],"responses":{"200":{"description":"A paginated page of debtors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebtorList"}}}},"401":{"$ref":"#/components/responses/Unauthorized"}}}}}}
```
## Retrieve a debtor
> Returns the debtor's profile, contact channels, and a summary of every placement they're tied to.
```json
{"openapi":"3.1.0","info":{"title":"Modern Collections API","version":"1.0.0"},"tags":[{"name":"debtors","description":"Look up the debtor entities behind placements. Each debtor may carry multiple placements over time."}],"servers":[{"url":"https://api.moderncollections.io/v1","description":"Production"},{"url":"https://sandbox.api.moderncollections.io/v1","description":"Sandbox"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Pass your API key as a Bearer token in the `Authorization` header."}},"schemas":{"Debtor":{"allOf":[{"$ref":"#/components/schemas/NewDebtor"},{"type":"object","properties":{"debtor_id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"placement_count":{"type":"integer"},"flags":{"type":"object","properties":{"cease_and_desist":{"type":"boolean"},"attorney_representation":{"type":"boolean"},"bankruptcy_filed":{"type":"boolean"}}}}}]},"NewDebtor":{"type":"object","required":["company_name","state"],"properties":{"company_name":{"type":"string"},"primary_domain":{"type":"string"},"primary_email":{"type":"string","format":"email"},"primary_phone":{"type":"string"},"state":{"type":"string","description":"Two-letter US state code."},"city":{"type":"string"},"zip":{"type":"string"},"entity_type":{"type":"string","enum":["corp","llc","sole_prop","partnership","other"]}}},"ErrorEnvelope":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Error"}}},"Error":{"type":"object","required":["code","category","message"],"properties":{"code":{"type":"string"},"category":{"type":"string","enum":["invalid_request","authentication","authorization","not_found","conflict","compliance_refusal","rate_limit","server_error"]},"message":{"type":"string"},"request_id":{"type":"string"}}}},"responses":{"Unauthorized":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"NotFound":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}},"paths":{"/debtors/{debtor_id}":{"get":{"summary":"Retrieve a debtor","description":"Returns the debtor's profile, contact channels, and a summary of every placement they're tied to.","tags":["debtors"],"operationId":"getDebtor","responses":{"200":{"description":"Debtor detail.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Debtor"}}}},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
```
## Update a debtor
> Update mutable fields on the debtor profile — usually to correct contact details or to set compliance-relevant flags like \`cease\_and\_desist\`.\
> \
> {% hint style="warning" %}\
> Setting \`cease\_and\_desist: true\` pauses outreach across \*\*all\*\* placements for this debtor within seconds.\
> {% endhint %}
```json
{"openapi":"3.1.0","info":{"title":"Modern Collections API","version":"1.0.0"},"tags":[{"name":"debtors","description":"Look up the debtor entities behind placements. Each debtor may carry multiple placements over time."}],"servers":[{"url":"https://api.moderncollections.io/v1","description":"Production"},{"url":"https://sandbox.api.moderncollections.io/v1","description":"Sandbox"}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Pass your API key as a Bearer token in the `Authorization` header."}},"schemas":{"DebtorUpdate":{"type":"object","properties":{"primary_email":{"type":"string","format":"email"},"primary_phone":{"type":"string"},"cease_and_desist":{"type":"boolean"},"attorney_representation":{"type":"boolean"},"bankruptcy_filed":{"type":"boolean"}}},"Debtor":{"allOf":[{"$ref":"#/components/schemas/NewDebtor"},{"type":"object","properties":{"debtor_id":{"type":"string","format":"uuid"},"created_at":{"type":"string","format":"date-time"},"placement_count":{"type":"integer"},"flags":{"type":"object","properties":{"cease_and_desist":{"type":"boolean"},"attorney_representation":{"type":"boolean"},"bankruptcy_filed":{"type":"boolean"}}}}}]},"NewDebtor":{"type":"object","required":["company_name","state"],"properties":{"company_name":{"type":"string"},"primary_domain":{"type":"string"},"primary_email":{"type":"string","format":"email"},"primary_phone":{"type":"string"},"state":{"type":"string","description":"Two-letter US state code."},"city":{"type":"string"},"zip":{"type":"string"},"entity_type":{"type":"string","enum":["corp","llc","sole_prop","partnership","other"]}}},"ErrorEnvelope":{"type":"object","properties":{"error":{"$ref":"#/components/schemas/Error"}}},"Error":{"type":"object","required":["code","category","message"],"properties":{"code":{"type":"string"},"category":{"type":"string","enum":["invalid_request","authentication","authorization","not_found","conflict","compliance_refusal","rate_limit","server_error"]},"message":{"type":"string"},"request_id":{"type":"string"}}}},"responses":{"BadRequest":{"description":"The request was malformed or failed validation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"Unauthorized":{"description":"Missing or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}},"NotFound":{"description":"The requested resource could not be found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}},"paths":{"/debtors/{debtor_id}":{"patch":{"summary":"Update a debtor","description":"Update mutable fields on the debtor profile — usually to correct contact details or to set compliance-relevant flags like `cease_and_desist`.\n\n{% hint style=\"warning\" %}\nSetting `cease_and_desist: true` pauses outreach across **all** placements for this debtor within seconds.\n{% endhint %}\n","tags":["debtors"],"operationId":"updateDebtor","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DebtorUpdate"}}}},"responses":{"200":{"description":"Updated debtor.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Debtor"}}}},"400":{"$ref":"#/components/responses/BadRequest"},"401":{"$ref":"#/components/responses/Unauthorized"},"404":{"$ref":"#/components/responses/NotFound"}}}}}}
```
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.moderncollections.io/rest-api-explorer/debtors.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.