Skip to content

Get mandate by ID

Get details for a specific mandate, including real-time remaining budget.

GET
/api/mandates/agent/{mandateId}

Authorizations

agentJwt

Agent registration JWT. Send as Authorization: Bearer <agent-jwt>.

Type
HTTP (bearer)

Responses

The mandate details.

application/json

A single mandate's details.

Valid values"ok"

An intent mandate with real-time budget state.

{
  "status": "<string>",
  "mandate": {
    "mandateId": "<string>",
    "status": "<string>",
    "isEnabled": "<boolean>",
    "naturalLanguage": "<string>",
    "category": "<string>",
    "currency": "<string>",
    "limitAmount": "<string>",
    "spentAmount": "<string>",
    "pendingSpentAmount": "<string>",
    "remainingAmount": "<string>",
    "validFrom": "<string>",
    "validUntil": "<string>",
    "hostAllowlist": [
      "<string>"
    ],
    "mandateHash": "<string>",
    "signedAt": "<string>",
    "createdAt": "<string>",
    "detailsUrl": "<string>",
    "signUrl": "<string>"
  }
}

Released under the MIT License.