Returns the profile of the user associated with the bearer token. The most common use is to discover your organisation ID for subsequent calls.

Query parameters

Parameter Type Required Description
include string no Comma-separated list of related data to embed. Accepts only locations and availableMetrics. Use it to skip a follow-up call to /organisation/:id/availableMetrics.

Example request

GET https://api.auravisionlabs.com/v1/users/profile?include=availableMetrics,locations
Authorization: Bearer <your_token>

Example response

{
  "id": "64a1b2c3d4e5f6a7b8c9d0e1",
  "name": "Jane Smith",
  "email": "user@example.com",
  "organisation": {
    "_id": "64a1b2c3d4e5f6a7b8c9d0e2",
    "name": "Acme Retail",
    "options": { "startOfWeek": "monday" }
  }
}

Notes

  • id is your user ID.
  • organisation is the full organisation object embedded inline — not just an ID. Its _id is the value to pass to GET /organisation/:id if you need a fresh fetch.
  • When include=availableMetrics is set, availableMetrics is an object (not an array) whose top-level keys group metric configuration by domain (e.g. movement, zones, service areas, sales).