Skip to main content
GET
/
plans
List all plans
curl --request GET \
  --url http://localhost:3001/portal-api/plans \
  --header 'Authorization: <api-key>'
{
  "data": [
    {
      "ID": 1,
      "Name": "free_plan_2",
      "DisplayName": "Free plan",
      "AutoApproveAccessRequests": true,
      "RateLimit": 5,
      "Quota": 0
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Query Parameters

​
limit
integer

Maximum number of records to return for this request. Overrides the row count only, not the page offset (which is always based on per_page), so use per_page for pagination rather than combining limit with page. Defaults to the per_page value.

​
per_page
integer
default:20

Items per page. Defaults to the resource-specific page count if configured, otherwise 20

​
page
integer
default:1

Page number. Defaults to 1 when omitted

Response

200 - application/json

OK

​
data
object[]