---
title: "Get user entitlements"
method: GET
path: "/platform/v1/entitlements"
tags: ["Entitlements"]
---

# Get user entitlements

`GET /platform/v1/entitlements`

## Request

- Base URL: `https://api.zoominfo.com/gtm`
- URL: `https://api.zoominfo.com/gtm/platform/v1/entitlements`
- Auth: OAuth 2
  - Authorization code: `https://login.zoominfo.com`
  - Token URL: `https://okta-login.zoominfo.com/oauth2/default/v1/token` scopes: `api:entitlement:read`

Retrieve user entitlements filtered by admin status and role type.

## Query parameters

- `filter[admin]` boolean, required
- `filter[roleType]` 'feature' | 'integration' | 'data' | 'dataset_detail' | 'action' | 'intent' | 'limit' | 'info' | 'signal' | 'vertical_dataset', required: Role type enumeration.

## Response `200`

Success

- EntitlementsResponse: Response model containing a list of entitlements.
  - `data` Entitlement[], required: The primary data of the document
    - `id` string, required: The unique identifier for the resource
    - `type` string, required: The type of the resource
    - `attributes` EntitlementAttributes, required: Entitlement details.
      - `roleCode` string, required: The role code.
      - `roleName` string, required: The role name, description of the role.
      - `roleType` 'feature' | 'integration' | 'data' | 'dataset_detail' | 'action' | 'intent' | 'limit' | 'info' | 'signal' | 'vertical_dataset', required: Role type enumeration.
      - `value` string, required: The role value, 'Y' indicates entitlement is granted, a number indicates the limit.

## Other responses

- `400`: Bad Request
- `401`: Unauthorized
- `403`: Forbidden
- `429`: Too Many Requests

---

[API](https://skmtc.dev/zoominfo/apis/platform-api-v1.md) - [All operations](https://skmtc.dev/zoominfo/apis/platform-api-v1/llms.txt) - [OpenAPI document](https://skmtc.dev/zoominfo/apis/platform-api-v1/revisions/3f7645433626?raw)