# GET /api/usage/entitlements

List entitlements with optional filters using continuation-token paging.

**Required permissions**: `Usage.PlatformDefaults`  
**Scope**: merchant

**Operation ID:** `GET_api_usage_entitlements`

## Authorization

Requires: Usage.PlatformDefaults, merchant scope.

Required permissions:
- `Usage.PlatformDefaults`

## Parameters

| Name | In | Required | Type | Description |
| --- | --- | --- | --- | --- |
| Scope | query | no | WinkPGUsageEntitlementScope | Filter by entitlement scope. |
| ResellerId | query | no | string(uuid) | Filter by reseller ID. |
| MerchantId | query | no | string(uuid) | Filter by merchant ID. |
| SkuCode | query | no | string | Filter by SKU code. |
| MaxResultCount | query | no | integer(int32) | Maximum number of results to return. |
| ContinuationToken | query | no | string | Continuation token from a previous page response. Null for the first page. |
| IncludeDeleted | query | no | boolean | Not used by this read-only endpoint. |
| IncludeInactive | query | no | boolean | Not used by this read-only endpoint. |
| suppressNulls | query | no | boolean | If true, omit properties with null values. |

## Responses

### 200

OK

**Content type:** `text/plain`

Schema: `PhoenixAbpCoreApplicationContractsContinuationPagedResultDtoOfWinkPGUsageDtosEntitlementsSkuEntitlementDto`

**Content type:** `application/json`

Schema: `PhoenixAbpCoreApplicationContractsContinuationPagedResultDtoOfWinkPGUsageDtosEntitlementsSkuEntitlementDto`

**Content type:** `text/json`

Schema: `PhoenixAbpCoreApplicationContractsContinuationPagedResultDtoOfWinkPGUsageDtosEntitlementsSkuEntitlementDto`

### 403

Forbidden

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 401

Unauthorized

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 400

Bad Request

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 404

Not Found

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 501

Not Implemented

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### 500

Internal Server Error

**Content type:** `text/plain`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

**Content type:** `text/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

### default

The request failed. The body carries the standard error envelope: a machine-readable `error.code`, a human-readable `error.message`, and `error.validationErrors` when the failure was a validation rejection. See the error-code reference in this document's description for the values `error.code` can take.

**Content type:** `application/json`

Schema: `WinkPGHttpRemoteServiceErrorResponse`

## See also

- [All documentation](https://docs.winkpg.io/llms.txt): the machine-readable index of every public page on this site.