Your leads
Scoped to your account and to the environment of the credential. Keyset pagination through an opaque cursor.
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
state?string
Filter by state.
Value in
- "draft"
- "submitted"
- "matched"
- "offers_available"
- "offer_accepted"
- "funded"
- "declined"
- "out_of_scope"
market?string
Filter by market. Alpha-2, alpha-3 and names are all accepted.
Value in
- "GB"
- "US"
- "CA"
- "AU"
- "IE"
- "ES"
- "NL"
- "BE"
- "DK"
- "SE"
- "PL"
- "FR"
cursor?string
The next_cursor from the previous page.
limit?integer
Range
1 <= value <= 100Default
25Response 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/leads"JSON
{ "leads": [ { "id": "string", "reference": "string", "partner_reference": "string", "state": "draft", "environment": "live", "country": "UK", "currency": "GBP", "business": { "name": "string", "company_number": "string" }, "contact": { "first_name": "string", "last_name": "string" }, "funding": { "amount": 0, "amount_band": "under_25k" }, "statements_available": true, "created_at": "string", "updated_at": "string" } ], "next_cursor": "string"}