Skip to main content
GET
Get approval request

Authorizations

Authorization
string
header
required

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

Headers

x-finops-version
string<date>
required
x-organization-id
string<uuid>
required

The ID of the entity that owns the requested resource.

Example:

"9d2b4c8f-2087-4738-ba91-7359683c49a4"

Path Parameters

approval_request_id
string<uuid>
required

Response

Successful Response

An approval request as seen by one particular caller.

Read endpoints only. The write actions keep returning ApprovalRequestResourceWithMetadata, so they neither carry a value that is stale by the time it is read nor pay for the lookup.

id
string<uuid>
required
created_at
string<date-time>
required
updated_at
string<date-time>
required
approval_type
enum<string>
required
Available options:
user_ids,
role,
reporting_manager
approved_by
string<uuid>[]
required
object_id
string<uuid>
required
object_type
enum<string>
required
Available options:
account,
accounting_config,
accounting_tax_rate,
approval,
approval_request,
approval_policy,
approval_policy_process,
audit_trail,
bank_account,
comment,
cost_center,
counterpart,
counterpart_address,
counterpart_bank_account,
counterpart_contact_person,
counterpart_partner_metadata,
counterpart_tax_id,
counterpart_vat_id,
delivery_note,
einvoicing,
entity,
entity_bank_account,
entity_settings,
entity_token,
entity_user,
entity_user_token,
entity_vat_ids,
export,
ledger_account,
mailbox,
monitescript_process,
ocr_task,
onboarding,
overdue_reminder,
partner,
partner_internal_config,
partner_settings,
partner_token,
payable,
payable_line_item,
payables_credit_note,
payables_purchase_order,
payment,
payment_intent,
payment_link,
payment_record,
payment_reminder,
person,
product,
project,
receivable,
reconciliation,
recurrence,
receipt,
role,
tag,
todo_task,
todo_task_mute,
transaction,
transaction_validation,
webhook,
workflow,
workflow_pipeline
required_approval_count
integer
required
Required range: x >= 1
status
enum<string>
required
Available options:
waiting,
approved,
rejected,
canceled
user_ids
string<uuid>[]
required
caller_is_policy_approver
boolean
default:false

Whether the approval policy on this request routes it to the calling user. Answered per caller, so it must not be cached against the approval request id alone. It is also the only thing that governs approving and rejecting here: a caller this reports false for is refused, whatever permissions they hold. Force approve is a separate action on the service that owns the object.

Example:

true

created_by
string<uuid> | null

ID of the user who created the approval request, or None if it was created by the system (e.g. by an approval policy worker).

Example:

"ea837e28-509b-4b6a-a600-d54b6aa0b1f5"

reject_reason
string | null
rejected_by
string<uuid> | null
role_ids
string<uuid>[] | null
submitted_by
string<uuid> | null