Справочник API публикуется на английском языке.
List organizations
GET
/api/companiesPersonal API keyConsole session
List organizations.
Requires a member. Instance admins can list the full directory; scope=accessible limits the list to organizations the caller can enter.
Авторизация
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. Как работают ключи.
Параметры запроса
scopestringНеобязательный
one of: "accessible"Ответы
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.
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.