API Reference

Permissions

Version: 5.0
Updated: 17th August 2026

Teams have been replaced

Teams were removed on 2026-06-30. Datasets no longer have a team field, and the /api/v3/teams and /api/v3/team endpoints no longer exist.
Access is now controlled by groups and permissions, which are managed through the web interface.

How access works

Every user has a set of site-wide capabilities, plus any number of grants on individual objects.

Administrators (admin: true) can do everything.
Dataset managers (manageDatasets: true) hold the editor role on every dataset on the site, so they can read, create, edit and delete any dataset.
Groups are named sets of users, indexed by a 5-character ID, eg. ab12x.
- A group may be flagged canCreateDatasets, which lets its members create new datasets. A member who creates a dataset is automatically granted the editor role on it.
- Groups can be granted a role on a dataset. Every member inherits that role.
Permissions are grants of a role on a single dataset, to either a user or a group.

Roles

Role	Can do
`reader`	View the dataset, even if it is private or archived.
`uploader`	Also add, replace and remove files and links, and set `nextReviewDate`. Other metadata is locked.
`editor`	Edit all metadata, manage files, and delete the dataset.

Public datasets are readable by everyone, so reader grants only matter for private and archived datasets.

Checking your own access

The whoami endpoint returns your capabilities, your groups, and every grant that applies to you.

/api/v3/whoami

{
  "id": 382,
  "admin": false,
  "manageDatasets": false,
  "groups": {
    "59m9r": {
      "id": "59m9r",
      "title": "Health Intelligence",
      "canCreateDatasets": true,
      "permit": {
        "dataset": { "20abc": { "id": "20abc", "role": "editor" } },
        "webpage": {},
        "blogpost": {}
      }
    }
  },
  "permit": {
    "dataset": { "444xy": { "id": "444xy", "role": "uploader" } },
    "webpage": {},
    "blogpost": {}
  }
  // [...]
}

Managing permissions

Groups and permissions are managed by site administrators and dataset managers through the web interface. There is currently no public API for creating groups or granting permissions.

If you were previously using the teams API to automate this, please contact support.