Company members

GET /company/users

Scope company:read
API key x-api-key
Base URL https://api.hub.akuasense.com/v1

Response

200

Company members

data array of CompanyMember always present
Show 6 attributes Hide attributes
- userId string always present
  
  User identifier.
- role string always present
  
  A member’s role within a company. OWNER and MANAGER can write, VIEWER only reads. Only an OWNER manages members (scope users:admin).
  
  Values: OWNERMANAGERVIEWER
- name string nullable always present
- lastName string nullable always present
  
  Last name, when entered separately.
- email string email nullable always present
- image string nullable always present
  
  Avatar URL.

Errors

401
Not authenticated
403
Insufficient scope, or resource outside your company

GET /company/users

curl https://api.hub.akuasense.com/v1/company/users \
  -H "x-api-key: YOUR_API_KEY"

const response = await fetch(
  'https://api.hub.akuasense.com/v1/company/users',
  {
    headers: {
      'x-api-key': 'YOUR_API_KEY',
    },
  },
);
const data = await response.json();

import requests

response = requests.get(
    "https://api.hub.akuasense.com/v1/company/users",
    headers={"x-api-key": "YOUR_API_KEY"},
)
data = response.json()

Response

{
  "data": [
    {
      "userId": "cmf8x2k4q0000js08w3n5p1rd",
      "role": "OWNER",
      "name": "Camille",
      "lastName": "Martin",
      "email": "camille.martin@example.com",
      "image": null
    },
    {
      "userId": "cmf8x2k4q0001js08b7t6y9ze",
      "role": "OWNER",
      "name": "Louis",
      "lastName": "Bernard",
      "email": "louis.bernard@example.com",
      "image": null
    }
  ]
}

application/json

{
  "type": "string",
  "title": "string",
  "status": 401,
  "detail": "string",
  "code": "string"
}

application/problem+json · example generated from the schema

{
  "type": "string",
  "title": "string",
  "status": 403,
  "detail": "string",
  "code": "string"
}

application/problem+json · example generated from the schema