Get a project
| Method | Path |
|---|---|
GET | /v1/slim/project/:id |
Authentication · 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.
Behaviour
addressandcontactcome from the organization stored inside the project.namefalls back to the project id when the project has no name.settings.timeZonedefaults toEurope/Berlinwhen none is stored.settings.trendsPerioddefaults tostart: "09:00:00"anddurationSeconds: 86400when none is stored.
Example
curl -X GET 'https://api.sandbox.ovok.com/v1/slim/project/3f1c2b7e-8d4a-4c1e-9b2f-6a7d5e4c3b21' \
-H "Authorization: Bearer ${OVOK_TOKEN}"
Successful response
200 — The project was retrieved successfully.
Errors
| Status | Meaning |
|---|---|
400 | The project is neither the caller's project nor a direct child of it, or it cannot be read. |
401 | The bearer token is missing or invalid. |
403 | The session has no profile, or its access policy lacks AccessPolicy:read or AccessPolicy:update. |
422 | id is not a UUID. |