Get an approval receipt

GET

/api/approval-receipts/{receiptId}

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/approval-receipts/example

Return an approval decision receipt and convenience receipt URLs.

Parameters

Path Parameters

receiptId

required

string

Responses

200

Approval decision receipt.

Media type application/json

object

receipt_id

required

string

artifact_id

string

request_id

string

approval_id

string

decision

required

string

request_status

required

string

grant_ids

required

Array<string>

completed_at

integer format: int64

expires_at

required

integer format: int64

receipt_path

string

receipt_portal_path

string

Example

{
  "receipt_id": "adr_123",
  "artifact_id": "apc_123",
  "request_id": "aprq_123",
  "approval_id": "appr_123",
  "decision": "approved",
  "request_status": "approved",
  "grant_ids": [
    "egr_123"
  ],
  "completed_at": 1770000000000,
  "expires_at": 1770086400000,
  "receipt_path": "/api/approval-receipts/adr_123",
  "receipt_portal_path": "/api/approval-receipts/adr_123/portal"
}

default

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}