Skip to content
/
Get collection agencies

Get collection agencies

Request

Security
oauth2(Required scopes: collection.agency:list) or bearerAuth or apiKeyHeader
Path
companyIdstringrequired

The unique company identifier.

Query
includeArchivedboolean

If set to true, includes archived objects

Default:false
GET
/companies/{companyId}/collection-agencies
curl -i -X GET \
  'https://sandboxapi.peach.finance/api/companies/{companyId}/collection-agencies?includeArchived=false' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success

Bodyapplication/json
countintegerread-only

Total number of items in this result.

statusinteger

HTTP status code.

dataArray of objects(CollectionAgency)
Response
{
  "count": 0,
  "status": 0,
  "data": [
    { … }
  ]
}