Get all filter values for all endpoints that allow filtering

GET /filters

Get all filter values for all endpoints that allow filtering

Query parameters

  • customers boolean

    Flag to include all possible customer id-value pairs in the response

  • products boolean

    Flag to include all possible product types in the response

  • partner_entities boolean

    Flag to include all possible partner entities' id-value pairs in the response

  • is_business_customers boolean

    Flag to only include customers of customer_type = business

Responses

GET /filters 
curl \
 -X GET https://<your_environment_name>-uat-api.canopyservicing.com/filters \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response example (200) 
{
  "customers": [
    {
      "customer_id": "can_1234",
      "value": "John Smith"
    }
  ],
  "products": [
    {
      "product_type": "REVOLVING"
    }
  ],
  "partner_entities": [
    {
      "partner_entity_id": "can_1234",
      "value": "Nuts'n Bolts LTD"
    }
  ]
}