# Get a project

Canonical page: https://docs.ovok.com/slim-apis/project/get-a-project

| Method | Path |
| --- | --- |
| `GET` | `/v1/slim/project/:id` |

[Authentication](/authentication) · [Access policies](/access-policies)

Returns a project's name, address, contact and settings. Use it to show or edit your project or one of its child projects.

**Auth:** Bearer token. The caller's access policy must grant `AccessPolicy:read` and `AccessPolicy:update` (project admins skip this check).
**Scope:** The project in the path. It must be the caller's project (from the token) or a direct child of it.

## Request [#request]

### Path parameters [#path-parameters]

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | `string (uuid)` | Yes | Project id. Your own project or a direct child of it. |

## Behaviour [#behaviour]

- `address` and `contact` come from the organization stored inside the project.
- `name` falls back to the project id when the project has no name.
- `settings.timeZone` defaults to `Europe/Berlin` when none is stored.
- `settings.trendsPeriod` defaults to `start: "09:00:00"` and `durationSeconds: 86400` when none is stored.


## Example [#example]

```bash
curl -X GET 'https://api.sandbox.ovok.com/v1/slim/project/b7a3d915-6e20-4c8f-9a14-3d5f7b9c1e68' \
  -H "Authorization: Bearer ${OVOK_TOKEN}"
```

## Successful response [#successful-response]

`200` — The project was retrieved successfully.

```json
{
  "resourceType": "Project",
  "id": "b7a3d915-6e20-4c8f-9a14-3d5f7b9c1e68",
  "name": "Example project",
  "address": [{ "line": ["Hauptstrasse 1"], "city": "Berlin", "postalCode": "10115", "country": "DE" }],
  "contact": [{ "telecom": [{ "system": "email", "use": "work", "value": "team@example.com" }] }],
  "settings": { "timeZone": "Europe/Berlin", "trendsPeriod": { "start": "09:00:00", "durationSeconds": 86400 } }
}
```

| Field | Type | Description |
| --- | --- | --- |
| `resourceType` | `"Project"` | Always `Project`. |
| `id` | `string (uuid)` | Project id. |
| `name` | `string` | Project name. The project id when the project has no name. |
| `address` | `object[]` | Postal addresses of the project. Left out when there are none. Each entry has the fields of `address[]` in the request: `use`, `type`, `text`, `line`, `city`, `district`, `state`, `postalCode` and `country`. |
| `contact` | `object[]` | Contact persons of the project. Left out when there are none. Each entry has the fields of `contact[]` in the request: `telecom`, `name` and `address`. |
| `settings` | `object` | Project settings. |
| `settings.timeZone` | `string` | Time zone name. `Europe/Berlin` when none is stored. |
| `settings.trendsPeriod` | `object` | The daily window that trends cover. |
| `settings.trendsPeriod.start` | `string` | Start time as `HH:MM:SS`. `09:00:00` when none is stored. |
| `settings.trendsPeriod.durationSeconds` | `number` | Length of the window in seconds. `86400` when none is stored. |

## Errors [#errors]

| Status | Meaning |
| --- | --- |
| [`400`](/errors/malformed-request) | The project is neither the caller's project nor a direct child of it, or it cannot be read. |
| [`401`](/errors/unauthenticated) | The bearer token is missing or invalid. |
| [`403`](/errors/forbidden) | The session has no profile, or its access policy lacks `AccessPolicy:read` or `AccessPolicy:update`. |
| [`422`](/errors/validation-failed) | `id` is not a UUID. |
