Approvals

Get approval

Get an approval

get/approvals/{approvalId}

Path parameters

approvalIdstring required

Approval ID (apr_*).

Headers

X-Instance-IDstring nullable

Caller-chosen identifier for the agent run, session, or conversation, required when an agent moves money.

Response

Successful Response

Changes

Changed in 6 of the 28 revisions of this API.28

Aug 27, 2026359d267dca881See the full diff
- ○
  deleted the header request parameter X-Agent-ID with deprecation
  request-parameter-removed-with-deprecation
Aug 27, 2026feb2ede065393See the full diff
- ○
  added the required property data/attributes/ach to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/attributes/denialReason to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/attributes/initiator to the response with the 200 status
  response-required-property-added
Aug 23, 2026b1ad79e918ac1See the full diff
- ○
  header request parameter X-Agent-ID was deprecated
  request-parameter-deprecated
Aug 11, 2026089aed4017a811See the full diff
- ●
  added the new ach enum value to the data/attributes/target/type response property for the response status 200
  response-property-enum-value-added
- ○
  removed the direct_payment enum value from the data/attributes/target/type response property for the response status 200
  response-property-enum-value-removed
Aug 9, 20260123533d83611See the full diff
- ●
  added the new direct_payment enum value to the data/attributes/target/type response property for the response status 200
  response-property-enum-value-added
Jul 26, 2026270e233e401c2See the full diff
- ○
  added the required property data/attributes/customer to the response with the 200 status
  response-required-property-added
- ○
  added the required property data/attributes/payment to the response with the 200 status
  response-required-property-added

Full history