FRfrontegg
Plans (Formerly Bundles)

Get Plan

Retrieve a paginated list of plans, with the abillity to search, order and filter by related entities

get/resources/plans/v1

Request

Query parameters

offsetnumber

Page offset of the results to return

limitnumber

Number of results per page

filterstring

Search input, searchable by name

orderBy'name' | 'createdAt'

Field to order results by create date (createdAt) or expiration date (expirationDate)

sortType'ASC' | 'DESC'

Sort type, ASC for ascending, DESC for descending

featureIdsstring[]

Comma separated feature IDs to filter results by

userIdsstring[]

Comma separated user IDs to filter results by

tenantIdsstring[]

Comma separated tenant IDs to filter results by

includeTenantEntitlementsstring

The tenant id to get the related entitlements for

Response

hasNextboolean

Example response

{
  "items": [
    {
      "id": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
      "vendorId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
      "name": "Test Plan",
      "defaultTreatment": "true",
      "rules": [
        {
          "description": "This is the first rule",
          "conditionLogic": "and",
          "conditions": [
            {
              "attribute": "myCustomAttribute",
              "attributeType": "custom",
              "op": "in_list",
              "value": {
                "list": [
                  "valueA",
                  "valueB"
                ]
              }
            }
          ],
          "treatment": "true"
        }
      ],
      "description": "This is a test plan",
      "createdAt": "2022-01-01T00:00:00",
      "updatedAt": "2022-01-01T00:00:00",
      "features": {
        "id": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
        "name": "Test Feature",
        "key": "test-feature",
        "permissions": [
          "permission.read",
          "permission.write"
        ]
      },
      "entitlements": {
        "id": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
        "name": "Test Feature",
        "key": "test-feature",
        "permissions": [
          "permission.read",
          "permission.write"
        ]
      }
    }
  ]
}

Changes

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