For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Get a Demo
Get StartedConceptsProductsGuidesUI ComponentsAPI Access
Get StartedConceptsProductsGuidesUI ComponentsAPI Access
    • Getting Started
    • Environments and Base URLs
    • Reference
  • API Reference
      • GETList Consumer Disputes
      • GETGet Consumer Bank Accounts
      • GETList Consumer Payment Cards
      • GETList Consumers
      • POSTCreate New Consumer
      • GETRetrieve Consumer
      • PUTUpdate Consumer
      • GETGet Consumers By PCID
      • GETList Consumer Addresses V 2
      • POSTCreate Address V 2
      • GETRetrieve Address V 2
      • PUTUpdate Address V 2
      • DELDelete Address V 2
      • GETList Consumer Invites
      • POSTCreate Consumer Invites
      • POSTCreate Consumer Dispute
      • POSTCreate Account Cancellation
Get a Demo
LogoLogo
API ReferenceConsumers

List Consumer Invites

GET
https://host.com/v2/consumers/:consumer_id/invites/
GET
/v2/consumers/:consumer_id/invites/
$curl https://host.com/v2/consumers/consumer_id/invites/ \
>     -H "Authorization: Bearer <token>"
200Retrieved
1{
2  "count": 123,
3  "results": [
4    {
5      "id": "string",
6      "consumer_id": "string",
7      "invite_code": "string",
8      "claimed": true,
9      "claimed_date": "2024-01-15T09:30:00Z",
10      "expiration_date": "2024-01-15T09:30:00Z"
11    }
12  ],
13  "next": "http://api.example.org/accounts/?page=4",
14  "previous": "http://api.example.org/accounts/?page=2"
15}
Was this page helpful?
Previous

Create Consumer Invites

Next
Built with

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

consumer_idstringRequired

Query parameters

pageintegerOptional
A page number within the paginated result set.
page_sizeintegerOptional
Number of results to return per page.
searchstringOptional
A search term.

Response

countinteger
resultslist of objects
nextstring or nullformat: "uri"
previousstring or nullformat: "uri"