Approval

List approvals

Changed on

List pending and processed approval workflow items for the current portal, such as API product subscriptions and developer registrations. Results are scoped to the portal of the request token.

get/api/approvals

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Query parameters

status'pending' | 'finished'

Approval status.

result'accepted' | 'rejected' | 'cancelled'

Approval outcome.

event'api_product_subscription' | 'developer_registration'

Approval event.

resource_type'api_product' | 'developer'

Resource type.

resource_namestring

Resource name.

operator_namestring

Operator name.

applicant_namestring

Applicant name.

pageinteger

Page number of the listed resources. Used together with page_size. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.

page_sizeinteger

Number of resources listed per page. Used together with page. For example, when there are 13 resources in total, if the query parameters are page=1&page_size=10, the GET response will show the route total as 13 and display 10 resources in the first page. If the query parameters are page=2&page_size=10, the GET response will show the route total as 13 and display 3 resources in the second page.

direction'asc' | 'desc'

Order to list the resources by. The sorting index follows the configuration of order_by.

order_by'applied_at' | 'resource_name' | 'operated_at'

Index to order approvals by.

searchstring

Condition to search resources by.

Response

totalinteger required

Total number of objects.

Example response

{
  "list": [
    {
      "id": "bd58fce2-b6cc-4d2d-a53c-6ce11b19c101",
      "created_at": "2025-01-01T00:00:00.000Z",
      "updated_at": "2025-01-01T00:00:00.000Z",
      "applied_at": "2025-01-01T00:00:00.000Z",
      "operated_at": "2025-01-01T00:00:00.000Z"
    }
  ],
  "total": 1
}

Changes