Referencia · Cuenta

Organizaciones

Devuelve las organizaciones a las que tiene acceso el usuario y, para cada una, lo que puede consultar a través de la API. Esta respuesta no está paginada.

Parámetros

Este endpoint no recibe parámetros.

Campos de cada elemento

uid string

Identificador de la organización. Usalo en el parámetro organization de los listados.

name string

Nombre de la organización.

neutral_zone boolean

true si es una organización de zona neutral, cuyos archivos y listas de reproducción pueden usar todas las demás organizaciones.

admin boolean

true si el usuario es administrador de la organización o de la organización principal. En ese caso, ve todo en la organización.

permissions object

Lo que el usuario puede consultar en esta organización.

permissions.tvs boolean

true si puede ver las TVs.

permissions.files boolean

true si puede ver los archivos.

permissions.playlists boolean

true si puede ver las listas de reproducción.

Errores posibles

• Los errores de clave y de límite valen para todos los endpoints. Ver todos los errores

curl "https://api.on-cloud.live/v1/organizations" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/organizations');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('API_KEY')],
]);
$response = json_decode(curl_exec($ch), true);

const res = await fetch('https://api.on-cloud.live/v1/organizations', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

{
  "data": [
    {
      "uid": "8f14e45fceea167a5a36dedd4bea2543",
      "name": "Loja Centro",
      "neutral_zone": false,
      "admin": true,
      "permissions": {
        "tvs": true,
        "files": true,
        "playlists": true
      }
    },
    {
      "uid": "1679091c5a880faf6fb5e6087eb1b2dc",
      "name": "Loja Shopping Norte",
      "neutral_zone": false,
      "admin": true,
      "permissions": {
        "tvs": true,
        "files": true,
        "playlists": true
      }
    }
  ]
}