La référence de l'API est publiée en anglais.

List organizations

GET/api/companies
Personal API keyConsole session
Veyra Docs TeamMis à jour le Version 3 · Historique

List organizations.

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

Autorisation

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. Fonctionnement des clés.

Paramètres de requête

scopestringFacultatifone of: "accessible"

Réponses

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.

Les erreurs renvoient {"error": "..."}, souvent avec un code et des details. Voir erreurs et limites.

Organizations