Membres de la société

GET /company/users

• Scope company:read
• Clé API x-api-key
• URL de base https://api.hub.akuasense.com/v1

Réponse

200

Membres de la société

• data tableau de CompanyMember toujours présent
  Afficher les 6 attributs Masquer les attributs

  • userId string toujours présent

    Identifiant de l’utilisateur.

  • role string toujours présent

    Rôle d’un membre dans une société. OWNER et MANAGER peuvent écrire, VIEWER ne fait que lire. Seul un OWNER gère les membres (scope users:admin).

    Valeurs : OWNERMANAGERVIEWER
  • name string peut être null toujours présent
  • lastName string peut être null toujours présent

    Nom de famille, quand il est saisi à part.

  • email string email peut être null toujours présent
  • image string peut être null toujours présent

    URL de l’avatar.

Erreurs

• 401

  Non authentifié

• 403

  Scope insuffisant ou ressource hors société

GET /company/users

cURL JavaScript Python

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

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

import requests

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

Réponse

200 401 403

{
  "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 · exemple généré depuis le schéma

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

application/problem+json · exemple généré depuis le schéma