# Project

> GET /v1/project — read the project your server key belongs to (project:read).

Source: https://docs.getbeekon.com/api/project/

A server key belongs to exactly one project. `GET /v1/project` returns that project — a cheap way to check which project and region a key points at, and that the key works.

## GET `/v1/project`

**Scope:** `project:read` · **Parameters:** none

```sh
curl -s https://api.in1.getbeekon.com/v1/project \
  -H "Authorization: Bearer $BEEKON_TOKEN"
```

**Response** `200`:

```json
{
  "id": "0199b2c4-1f3a-7c11-9d2e-5a6b7c8d9e0f",
  "cell": "in1",
  "created_at": "2026-10-07T06:30:00.000Z",
  "name": "Fleet tracking",
  "status": "active"
}
```

| Member       | Type   | Meaning                                                                                                                         |
| ------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------- |
| `id`         | string | The project id, a lowercase UUID.                                                                                               |
| `name`       | string | The project’s display name.                                                                                                     |
| `cell`       | string | The region the project lives in — the same value as your key’s second segment and your API host’s (`api.<cell>.getbeekon.com`). |
| `status`     | string | `active` or `suspended`.                                                                                                        |
| `created_at` | string | When the project was created, RFC 3339 UTC.                                                                                     |

These five members are the whole object; your client should still ignore members it does not know, as with every `/v1` object.

* **Suspended projects still answer.** A suspended project’s session reads `"status":"suspended"` with a `200`; this endpoint reports the status, it does not enforce it.
* **Renames are eventually consistent.** The API serves the region’s copy of your project, so a rename can take a short while to appear here.
* **There is no project id in the path.** The project comes from the token. `/v1/projects`, `/v1/projects/{id}` and `/v1/project/{id}` do not exist (`404`), and query parameters such as `project_id` are ignored.
* Only `GET` (and `HEAD`) is served; other methods answer `405 method_not_allowed` with `Allow: GET, HEAD`.

## Errors

| Status | `error`                                          | When                                                                                                                                     |
| ------ | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------- |
| 401    | `missing bearer token` · `invalid session token` | No valid session.                                                                                                                        |
| 403    | `server credentials required`                    | The token was minted from an SDK key.                                                                                                    |
| 403    | `insufficient scope`                             | The key lacks `project:read`.                                                                                                            |
| 404    | `not found`                                      | The token’s project is no longer hosted on this region — for example, it was deleted. Do not retry; mint a new token from a current key. |
| 500    | `internal error`                                 | A failure on our side. Retry with backoff.                                                                                               |
