API Reference

Whoami

Version: 2.0
Updated: 17th August 2026

The "who am i?" endpoint returns information about the current user. Use this to verify your API key, and see your group memberships and permissions.

Admin users have admin: true in the response. They have full access to everything on the site.
Users with manageDatasets: true are dataset managers: they hold the editor role on every dataset on the site, including private and archived ones.
Everyone else works through groups and permissions. See Permissions.

GET

https://data.website/api/v3/whoami

HTTP Headers

Authorization

API key.

string

Optional

HTTP Return Codes

200	Returns JSON object, or null if not logged in.

/api/v3/whoami

{
  // My user ID:
  "id": 382,
  // My identity:
  "title": "Stevie Spreadsheets",
  "email": "[email protected]",
  // Site administrator? If true, everything below is redundant.
  "admin": false,
  // Can I manage all datasets on the site?
  "manageDatasets": false,
  // Can I manage all content (webpages & blog posts) on the site?
  "manageContent": false,
  // Dataset IDs I have starred:
  "stars": ["ab123"],

  // Groups I am a member of, keyed by group ID:
  "groups": {
    "59m9r": {
      "id": "59m9r",
      "title": "Health Intelligence",
      // Membership of this group lets me create new datasets:
      "canCreateDatasets": true,
      // Objects the group has been granted access to, keyed by object ID:
      "permit": {
        "dataset": {
          "20abc": { "id": "20abc", "role": "editor" },
          "v8wmv": { "id": "v8wmv", "role": "reader" }
        },
        "webpage": {},
        "blogpost": {}
      }
    }
  },

  // Objects I have personally been granted access to:
  "permit": {
    "dataset": {
      "444xy": { "id": "444xy", "role": "uploader" }
    },
    "webpage": {},
    "blogpost": {}
  }
}

Roles

Each grant carries one of these roles:

reader — can view the dataset, even if it is private or archived.
uploader — can also add, replace and remove files and links, and set the next review date. Cannot edit other metadata.
editor — can edit everything, including deleting the dataset.