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

KeyShapeMeaning
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

StatusCodeMeaning
400VALIDATION_ERRORThe id is not a UUID.
401Missing or invalid API key.
403The key does not hold organizations:read.
404NOT_FOUNDThe organisation is not in this key's scope.

Required scope: organizations:read