FRfrontegg
Entitlements

Get Entitlements

Retrieve a paginated list of Entitlements, with the ability to order, sort (ASC for ascending, DESC for descending), and filter results( expiration date (expirationDate) or create date (createdAt) fields

get/resources/entitlements/v2

Request

Query parameters

offsetnumber

Page offset of results to return

limitnumber

Number of results per page

sortType'ASC' | 'DESC'

Sort type, ASC for ascending, DESC for descending

planIdstring

UUID string representing the plan ID

planIdsstring[]

UUIDs string array representing the plan IDs

assignLevel'USER' | 'TENANT'

Assign level, USER for user-level entitlements, TENANT for tenant-level entitlements

orderBy'expirationDate' | 'createdAt'

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

userIdsstring[]

Comma separated user IDs to filter results by

tenantIdsstring[]

Comma separated tenant IDs to filter results by

withRelationsboolean

Boolean value to include related entities in the response

Response

hasNextboolean

Example response

{
  "items": [
    {
      "id": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
      "planId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
      "tenantId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
      "userId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
      "expirationDate": "2022-01-01T12:00:00",
      "createdAt": "2022-01-01T12:00:00",
      "updatedAt": "2022-01-01T12:00:00",
      "plan": {
        "id": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
        "vendorId": "e6a5012c-cbeb-4c1e-ab80-e5f43efd44e3",
        "name": "Test Plan",
        "description": "This is a test plan",
        "createdAt": "2022-01-01T00:00:00",
        "updatedAt": "2022-01-01T00:00:00"
      }
    }
  ]
}

Changes

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