DataPress logo
API Reference

Users

Version:  4.0
Updated:  14th July 2024

This API is read-only. Users are created through the website interface. They are assigned an immutable numeric id.

Editors Only
User data is only available to site administrators and dataset editors.
The API will redact the title, email, and admin fields for public users.

List all users

GET
https://data.website/api/users
HTTP Headers
AuthorizationAPI key. Non-editor users will receive redacted data.stringOptional
HTTP Return Codes
200JSON list of users, or redacted information.
/api/users
[
  {
    "id": 10,
    "title": "Admin User",
    "email": "[email protected]",
    "admin": true,
    "teams": [ "05jg5", "59m9r" ]
  },
  {
    "id": 11,
    "title": "Regular User",
    "email": "[email protected]",
    "admin": false,
    "teams": []
  }
  // ...
}