La referencia de la API se publica en inglés.

List organizations

GET/api/companies
Personal API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

List organizations.

Requires a member. Instance admins can list the full directory; scope=accessible limits the list to organizations the caller can enter.

Autorización

Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Cómo funcionan las claves.

Parámetros de consulta

scopestringOpcionalone of: "accessible"

Respuestas

200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation. details names each field that failed.
401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Organizations