approvalRequest

Get all the approval requests.

Requires the QUOTE.VIEW, INVOICE.VIEW or PRICING_PLAN_SCHEDULE.VIEW permission. Returns only approval requests whose source you may view: QUOTE_VERSION requires QUOTE.VIEW; INVOICE requires INVOICE.VIEW; PRICING_PLAN_SCHEDULE requires PRICING_PLAN_SCHEDULE.VIEW. Expanding approval_policies also requires APPROVAL_POLICY.VIEW.

get/v{version}/approval-requests

Request

  • Base URL: https://test.api.solvimon.com
  • URL: https://test.api.solvimon.com/v{version}/approval-requests
  • Auth: API key in header X-API-KEY

Path parameters

versionstring required

version

Query parameters

source_typestring

The object type in which this Approval Request was triggered. I.e. INVOICE.

source_idstring

The ID of the object type that triggered this Approval Request.

source_ids[]string[]

Filter Approval Requests based on multiple source IDs of the same source_type, e.g. pricing plan schedules of a subscription.

user_idstring

The ID of the user to check if they are an approver.

statuses[]string[]

Filter Approval Request based on status(es)

limitinteger

The amount of records shown in the list

pageinteger

The page which is going to be shown

order_bystring

The parameter by which the response is ordered.

order_directionstring

The order direction by which the response is ordered.

expand[]string[]

The id fields of the resources that are going to be expanded.

Headers

x-platform-idstring

Platform ID.

Response

OK

limitinteger nullable
pageinteger nullable
total_number_of_pagesinteger nullable

Changes

No recorded changes to this operation across all 1 revision of this API.