# Organizations

Organization · PassBook API reference. Authenticate with `Authorization: Bearer $PASSBOOK_KEY`.

## Read the organization's own features {#entitlements-retrieve}

`GET /api/v1/orgs/{id}/entitlements`

Scopes: `org:read`. SDK name: `pb.orgs.entitlements.retrieve`.

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `id` | path | string · max 64 | yes |  |

Returns `200`.

| Code | Status | Fix |
| --- | --- | --- |
| `BRAND_IMAGE_NOT_FOUND` |  | Upload the image with PUT /api/v1/orgs/{id}/branding/{slot} and use the URL it returns. |
| `BRAND_MARK_NOT_ALLOWED` |  | Remove the setting, or ask the platform owner to enable it for the organization. |
| `ENTITLEMENTS_CHANGED` |  | Fetch them with GET /api/v1/orgs/{id}/entitlements and send your change again. |
| `FORBIDDEN` |  | Use a key with the scope the operation lists, or ask an org admin. |
| `IDENTITY_NOT_FOUND` |  | Check the id with GET /api/v1/identities. |
| `IMAGE_BYTES` |  | Compress the image and upload it again. |
| `IMAGE_INVALID` |  | Export a standard PNG and upload it again. |
| `IMAGE_NOT_FOUND` |  | Upload one with PUT /api/v1/orgs/{id}/branding/{slot}. |
| `IMAGE_SCALE` |  | Resize so the @2x image is two thirds of the @3x, then upload both. |
| `IMAGE_SIZE` |  | Resize to the size named in issues and upload it again. |
| `INVALID_API_KEY` |  | Create a new key in the console and update PASSBOOK_KEY. |
| `INVITATION_INVALID` |  | Ask an organization admin to send a new invitation with POST /api/v1/orgs/{id}/invitations. |
| `INVITATION_PENDING` |  | Revoke it to send a new one. |
| `LAST_ORG_ADMIN` |  | Make someone else an org admin first. |
| `MEMBERSHIP_CONFLICT` |  | Fetch it with GET /api/v1/orgs/{id}/memberships and send the change again. |
| `MISSING_SCOPE` |  | Create a key with the scope the operation lists under security. |
| `NOT_FOUND` |  | Check the id, and that the key's mode (test or live) matches the object. |
| `ORG_CONFLICT` |  | Fetch it with GET /api/v1/orgs/{id} and send the change again. |
| `ORG_NOT_FOUND` |  | Check orgId with GET /api/v1/orgs. |
| `ORG_PERSONAL_SINGLE_MEMBER` |  | Use a regular organization to work with others. |
| `ORG_SLUG_RESERVED` |  | Choose a different slug. |
| `ORG_SLUG_TAKEN` |  | Choose a different slug. |
| `ORG_STATUS_ALONE` |  | Send the status change in its own request, then the other edits. |
| `RATE_LIMITED` |  | Wait for Retry-After seconds, then retry. Back off on repeats. |
| `SETTINGS_CHANGED` |  | Fetch them with GET /api/v1/settings and send your change again. |
| `UNAUTHENTICATED` |  | Send Authorization: Bearer $PASSBOOK_KEY. |
| `VALIDATION` |  | Fix each field in issues and resend. |

```sh
curl -X GET "https://passbook.mobile/api/v1/orgs/0193a1b2-7c00-7000-8000-0000000000a1/entitlements" \
  -H "Authorization: Bearer $PASSBOOK_KEY"
```

## Console only

Signed-in console sessions only; an API key cannot call these.

- `PATCH /api/v1/orgs/{id}`: Update an organization
- `GET /api/v1/orgs/{id}/workspace`: Get an organization workspace
- `GET /api/v1/orgs/{orgId}/lifecycle`: Read the open or closed state of an organization
- `POST /api/v1/orgs/{orgId}/close`: Close an organization: read-only, passes stop updating, 30 days to export
- `POST /api/v1/orgs/{orgId}/reopen`: Reopen a closed organization inside its 30 days
