Skip to main content
GET
/
v1
/
intents
List all intents
curl --request GET \
  --url https://api.useproxy.ai/v1/intents \
  --header 'Api-Key: <api-key>'
{
  "cardId": "<string>",
  "intents": [
    {
      "id": "<string>",
      "cardId": "<string>",
      "intentId": "<string>",
      "summary": "<string>",
      "status": "pending",
      "expiresAt": 123,
      "createdAt": 123,
      "expectedAmount": 123,
      "expectedCurrency": "<string>",
      "expectedMerchant": "<string>",
      "tolerance": 123,
      "approvalRequired": true,
      "approvedAt": 123,
      "approvedBy": "<string>",
      "rejectedAt": 123,
      "rejectedBy": "<string>",
      "rejectionReason": "<string>",
      "transactionId": "<string>",
      "matchResult": {
        "amountMatch": true,
        "merchantMatch": true,
        "actualAmount": 123,
        "actualMerchant": "<string>"
      },
      "matchedAt": 123
    }
  ]
}

Authorizations

​
Api-Key
string
header
required

API key for authentication. Get your key from the Dashboard.

Query Parameters

​
cardId
string

Filter by card ID

​
agentId
string

Filter by agent ID

​
status
enum<string>

Filter by intent status

Available options:
pending,
pending_approval,
rejected,
matched,
mismatched,
expired,
canceled
​
limit
integer
default:20

Number of items per page (max 100)

Required range: 1 <= x <= 100
​
cursor
string

Pagination cursor from previous response

Response

Intent list

​
cardId
string
required
​
intents
object[]
required