Your customers
Filter by band (likely for the customers to tell now) and by changed_since for what moved. Ordered by partner_customer_id; page with after.
AuthorizationBearer <token>
An access token from POST /oauth/token. Valid for one hour. Preferred, because a leaked request log then exposes an hour rather than a permanent credential.
In: header
Query Parameters
band?string
Value in
- "likely"
- "possible"
- "not_yet"
- "unlikely"
- "not_assessed"
changed_since?string
Format
date-timeafter?string
limit?integer
Range
1 <= value <= 500Default
100Response Body
application/json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
application/problem+json
Shell
curl -X GET "https://sandbox.capvant.com/customers"JSON
{ "data": [ { "object": "customer", "partner_customer_id": "string", "environment": "live", "market": "UK", "company_number": "string", "business_name": "string", "eligibility": { "band": "likely", "confidence": "high", "headline": "string", "reason": "string", "families": [ {} ], "next_best_action": {}, "cautions": [ {} ], "register_as_of": "2019-08-24" }, "eligibility_checked_at": "2019-08-24T14:15:22Z", "eligibility_changed_at": "2019-08-24T14:15:22Z", "next_check_at": "2019-08-24T14:15:22Z", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z" } ], "next_after": "string"}