---
title: "Get entitlements"
description: "Retrieve the features and limits of an account plan, e.g."
canonical: https://www.charitips.com/docs/api-reference/get-entitlements
---

# Get entitlements

`GET /v1/accounts/{accountId}/entitlements`

Retrieve the features and limits of an account plan, e.g. to know whether a child account can use custom domains or B2C donations.

**Authentication**: Bearer access token.

## Parameters

- `accountId` (string, required)

## Response 200

- `apiAccess` (boolean, required)
- `widget` (boolean, required)
- `donorPlatform` (boolean, required)
- `activeExperiences` (number)
- `donors` (number)
- `userSeats` (number)
- `editorSeats` (number)
- `payrollManagerSeats` (number)
- `monthlyCharitiesSelection` (boolean, required)
- `handPickedCharitiesSelection` (boolean, required)
- `additionalCharities` (number)
- `minCharitiesInSelection` (number, required)
- `impactSharing` (boolean, required)
- `impactMonitoring` (ImpactMonitoringLevel, required) One of `CAMPAIGN_END`, `LIVE`, `LIVE_WITH_ACCOUNT_SEGMENTATION`.
- `analyticsIntegration` (boolean, required)
- `slackIntegration` (boolean, required)
- `teamsIntegration` (boolean, required)
- `customDomain` (boolean, required)
- `sso` (boolean, required)
- `bankTransferPayment` (boolean, required)
- `accountHierarchy` (boolean, required)
- `platform` (boolean, required)
- `delegatedBilling` (boolean, required)
- `agency` (boolean, required)
- `b2c` (boolean, required)
- `fiscalReceiptClaimOnExpiration` (boolean, required)
- `dashboardAccess` (boolean, required)
- `accountId` (string, required)

## Errors

- 401 `Unauthorized`: The access token is missing, expired or invalid. Create a new one with your client id and secret, send it as `Authorization: Bearer <accessToken>`, then retry once. Sandbox tokens only work on api.sandbox.charitips.com. See https://www.charitips.com/docs/get-started/authentication.md.
- 403 `Account closed`: The account behind these credentials is closed: no token is issued and every call is refused, reads included. Contact Charitips to reopen it. See https://www.charitips.com/docs/api-reference/troubleshooting.md#calls-answer-403-account-not-active-account-not-validated-or-account-closed.

## Example

```bash
curl -X GET https://api.sandbox.charitips.com/v1/accounts/<accountId>/entitlements \
  -H "Authorization: Bearer $CHARITIPS_TOKEN"
```

```javascript
const response = await fetch('https://api.sandbox.charitips.com/v1/accounts/<accountId>/entitlements', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.CHARITIPS_TOKEN}`,
  },
});
if (!response.ok) throw new Error(`${response.status} ${await response.text()}`);
const data = await response.json();
```

```python
import os, requests

response = requests.get(
    "https://api.sandbox.charitips.com/v1/accounts/<accountId>/entitlements",
    headers={"Authorization": f"Bearer {os.environ['CHARITIPS_TOKEN']}"},
)
response.raise_for_status()
data = response.json()
```

## Response example (200, placeholder values)

```json
{
  "apiAccess": false,
  "widget": false,
  "donorPlatform": false,
  "activeExperiences": 1,
  "donors": 1,
  "userSeats": 1,
  "editorSeats": 1,
  "payrollManagerSeats": 1
}
```