# Check one entitlement slug against the user and their workspaces

Each subject in subjects ({user: true} or {workspaceId}) answers from its own entitlement, in the order given, and allowed is true when any of them allows it.

> **Note:**

**Not fully described yet.** The API description has no described successful answer for this operation yet. The method, path, sign-in, rate limits and request fields on this page are read from the server's code and are accurate; what a successful call returns is not written down here yet. Until it is, search engines and the agent index leave this page out.

`POST /api/v1/public/me/entitlements/check`

- Sign-in: A signed-in user's session: send the session id in the x-session-id header.
- Rate limit: Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted).

Each subject in `subjects` (`{user: true}` or `{workspaceId}`) answers from its own entitlement, in the order given, and `allowed` is true when any of them allows it. `current` is the caller's count for a limit and `wanted` what the request would add. Answers 403 when the user is not a member of a named workspace or the workspace's company rules refuse them.

## Request

Send the body as `application/json`.

| Field                    | Type            | Required | Constraints                        | Description                             |
| ------------------------ | --------------- | -------- | ---------------------------------- | --------------------------------------- |
| `slug`                   | string          | Yes      | matches `^[A-Za-z0-9._:-]{1,128}$` | -                                       |
| `subjects`               | array of object | Yes      | at least 1 items, at most 5 items  | -                                       |
| `subjects[].user`        | boolean         | No       | always `true`                      | Required in one of the accepted shapes. |
| `subjects[].workspaceId` | string          | No       | matches `^[a-fA-F0-9]{24}$`        | Required in one of the accepted shapes. |
| `current`                | integer         | No       | at least 0                         | -                                       |
| `wanted`                 | integer         | No       | at least 1                         | -                                       |

## Example request

Replace each `YOUR_...` value with your own, and set the credential in the environment variable the sample reads.

```bash title="cURL"
curl -X POST "https://api.console.buildbase.app/api/v1/public/me/entitlements/check" \
  -H "x-session-id: $BUILDBASE_SESSION_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "slug": "string",
  "subjects": [
    {
      "user": true
    }
  ]
}'
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/me/entitlements/check',
  {
    method: 'POST',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
      'Content-Type': 'application/json',
    },
    body: JSON.stringify({
      slug: 'string',
      subjects: [
        {
          user: true,
        },
      ],
    }),
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.text();
```

```python title="Python"
import os

import requests

response = requests.post(
    "https://api.console.buildbase.app/api/v1/public/me/entitlements/check",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    json={
        "slug": "string",
        "subjects": [
            {
                "user": True,
            },
        ],
    },
    timeout=30,
)
response.raise_for_status()
data = response.text
```

## Responses

A successful answer is not described yet. The server answers with the status and body its handler sends.

### Any other status

The handler's own answer. Not described yet: response bodies come from captured responses (server/openapi/captured) and overlays (server/openapi/overlays).

## Errors

Each refusal, what it means, and what to do. The request changed nothing.

### 400 Bad Request

**What it means:** The request failed a `validate()` schema, or an id in the path is not a valid id. `path` names the field.

**What to do:** Fix the field the body names in `path` (or read `message`) and send the request again. Nothing was changed.

```json title="Example"
{
  "error": true,
  "success": false,
  "path": "string",
  "message": "string"
}
```

### 401 Unauthorized

**What it means:** The credential is missing, expired or not accepted here, or the caller's role has no grant for `x-permission` (refused with 401 too). The body is the plain text `Unauthorized`, or a JSON body with a `code` where the gate says why.

**What to do:** Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

```text title="Example"
Unauthorized
```

### 429 Too Many Requests

**What it means:** A rate limit in `x-rateLimit` was reached. `retryAfter` and the `Retry-After` header say how many seconds until the window resets.

**What to do:** Wait the number of seconds in the `Retry-After` header (also `retryAfter` in the body), then retry. Slow down repeated calls.

```json title="Example"
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}
```

## Related

- [All Me operations](/http-api/reference/me)
- [API reference](/http-api/reference): every operation, by tag
- [Sign-in and credentials for the HTTP API](/http-api/authentication)
- [How the HTTP API reports errors](/http-api/errors)
- [Make your first call](/http-api/first-call)
- [Error codes](/reference/error-codes): every `code` the API returns
- OpenAPI: operation `me.entitlements.check.create` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
