Справочник API публикуется на английском языке.

List organization members

GET/api/companies/{companyId}/members
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

List organization members.

Board members or agents holding users:manage_permissions in this organization. Returns each member's role, status and explicit grants. Changing a member's role, grants or status stays board-only: A person makes this change on the Members page at //company/settings/members (prefix = the organization's task prefix); link that page as a Markdown link.

Авторизация

Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Как работают ключи.

Параметры пути

companyIdstringОбязательныйThe organization's id.

Ответы

200SuccessThe request worked; the body holds the result.
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.
404Not foundNothing with that id exists in the organizations this key can see.

Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.

Members, invites and keys