Get all the approval requests.

GET

/v:version/approval-requests

GET

/v:version/approval-requests

curl https://test.api.solvimon.com/v1/approval-requests \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json"

{
  "data": [
    {
      "object_type": "approval_request",
      "id": "ar_9f8b7c6d5e4a3b2c1d0e",
      "approval_policy_ids": [
        "ap_1234567890abcdef"
      ],
      "approval_policies": [
        {
          "object_type": "approval_policy",
          "id": "ap_1234567890abcdef",
          "source_type": "QUOTE_VERSION",
          "reference": "QTV-2024-001",
          "name": "Standard Discount Approval",
          "status": "DRAFT",
          "approval_type": "GROUP",
          "created_at": "2024-05-01T10:15:30Z",
          "update_at": "2024-05-10T12:00:00Z",
          "approvers": {
            "type": "ALL_LEVELS_MUST_APPROVE",
            "approval_groups": [
              {
                "level": 1,
                "approvers": [
                  {
                    "type": "USER",
                    "user": {
                      "id": "user_7890abcd1234ef56"
                    }
                  }
                ]
              }
            ]
          },
          "rule_groups": [
            {
              "rules": [
                {
                  "type": "DISCOUNT",
                  "comparator": "GREATER_THAN",
                  "discount": {
                    "percentage": "15",
                    "amount": {
                      "quantity": "1500.00",
                      "currency": "USD"
                    }
                  },
                  "commitment": {
                    "amount": {
                      "quantity": "0",
                      "currency": "USD"
                    }
                  },
                  "pricing": {
                    "has_override": false
                  },
                  "custom_field": {
                    "id": "cf_001",
                    "value": "priority_high"
                  },
                  "billing_entity": {
                    "is_custom": false
                  },
                  "billing_period": {
                    "is_custom": false
                  },
                  "due_date": {
                    "is_custom": false
                  },
                  "payment_acceptor": {
                    "is_custom": false
                  }
                }
              ]
            }
          ]
        }
      ],
      "source_type": "QUOTE_VERSION",
      "source_id": "qv_20240515_001",
      "status": "PENDING_REVIEW",
      "owner_id": "user_1234abcd5678ef90",
      "created_at": "2024-05-15T09:00:00Z",
      "updated_at": "2024-05-16T14:30:00Z",
      "reviewers": [
        {
          "id": "user_7890abcd1234ef56",
          "status": "PENDING_REVIEW",
          "reviewed_at": "2024-05-16T14:00:00Z",
          "level": 1
        }
      ],
      "approval_strategy": "ALL_LEVELS_MUST_APPROVE",
      "reviewed_at": "2024-05-16T14:30:00Z"
    }
  ],
  "links": {
    "first": "https://api.solvimon.com/v1/approval-requests?page=1&limit=25",
    "previous": null,
    "current": "https://api.solvimon.com/v1/approval-requests?page=1&limit=25",
    "next": "https://api.solvimon.com/v1/approval-requests?page=2&limit=25"
  },
  "limit": 25,
  "page": 1,
  "total_number_of_pages": 3
}

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.

Authentication

X-API-KEYstring

API Key authentication via header

AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1

version

Query parameters

source_typestringOptional

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

source_idstringOptional

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

source_ids[]list of stringsOptional

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

user_idstringOptional

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

statuses[]list of stringsOptional

Filter Approval Request based on status(es)

limitintegerOptional

The amount of records shown in the list

pageintegerOptional

The page which is going to be shown

order_bystringOptional

The parameter by which the response is ordered.

order_directionstringOptional

The order direction by which the response is ordered.

expand[]list of stringsOptional

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

Response

datalist of objects

linksobject

limitinteger or nullOptional

pageinteger or nullOptional

total_number_of_pagesinteger or nullOptionalDeprecated

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

500

Internal Server Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors