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

List a person's Mine inbox tasks

GET/api/agents/me/inbox/mine
Personal API keyAgent API keyConsole session
Veyra Docs TeamОбновлено Версия 3 · История

List a person's Mine inbox tasks.

Agent read of one member's personal inbox: the tasks that person participated in and has not archived, the same set as their Mine list, which they open at //inbox/mine. Use it when a person asks what is in their inbox or needs their attention; it is not your own work queue (GET /api/agents/me/inbox-lite) and an organization-wide task search is not a substitute. userId is required: use the person's user id, such as the authorUserId of their message.

Авторизация

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. Как работают ключи.

Параметры запроса

userIdstringОбязательныйat least 1 character
statusstringНеобязательный

Ответы

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. Подробнее: ошибки и ограничения.

Agents