Get Settings
Read the settings that apply to an organisation.
โถRequest
โถMethod & Path
GET /organizations/:id/settings
โถPath parameters
idโ any organisation in the caller's scope: its own, or a child.
โถHeaders
x-api-keyโ API key.x-acting-asโ optional child organisation ID.
โถResolution
Each key resolves on its own: the organisation's own value, else its
parent's. A key that neither has is absent, so settings can be {}.
sources names, per key, the organisation the value came from, or null.
A child that sets only dashboard_tags still gets its parent's
packaging_rules.
โถSettings
| Key | Shape | Meaning |
|---|---|---|
packaging_rules | [{ target, selector, group_by }] | One rule per target, e.g. eudr.dds. group_by is a tag namespace: each of its values gets its own submission. |
dashboard_tags | [{ namespace, label, filterable }] | Tag namespaces the app shows as columns, in this order, with a label. filterable adds the namespace to the tag filter. |
โถErrors
| Status | Code | Meaning |
|---|---|---|
| 400 | VALIDATION_ERROR | The id is not a UUID. |
| 401 | Missing or invalid API key. | |
| 403 | The key does not hold organizations:read. | |
| 404 | NOT_FOUND | The organisation is not in this key's scope. |
Required scope:
organizations:read