Skip to Content

Отправки

Отправки — это ваши сообщения об ошибках и запросы функций — те же посты, которые пользователи создают на портале, доступные для чтения и записи через API. (Общий фидбэк имеет отдельный конечный пункт; см. Фидбэк.)

Все конечные точки требуют аутентификации и ограничены проекту API-ключа.

Список отправок

GET/v1/submissions

ParameterTypeDescription
statusstringФильтр: backlog, open, planned, in_progress, или done.
typestringФильтр: bug или feature.
limitintegerРазмер страницы. По умолчанию 20.
offsetintegerКоличество элементов для пропуска. По умолчанию 0.
curl "https://api.supdesk.app/v1/submissions?status=open&limit=10" \ -H "Authorization: Bearer sd_live_..."

Ответы используют стандартную упаковку списка:

{ "data": [ { "id": "8f7a…", "type": "bug", "title": "Export button unresponsive on Safari", "body": "Clicking Export does nothing on Safari 26.", "status": "open", "is_private": false, "created_at": "2026-07-01T09:12:00Z" } ], "pagination": { "limit": 10, "offset": 0, "has_more": false } }

Получить отправку

GET/v1/submissions/:id

Возвращает одну отправку как { "data": { … } }, или ошибку 404 not_found.

Создать отправку

Pro Доступ к записи требует платного плана; на Free это возвращает 403 forbidden.

POST/v1/submissions

ParameterTypeDescription
typerequiredstringbug или feature.
titlerequiredstringКраткое описание отправки.
emailrequiredstringЭлектронная почта конечного пользователя, к которому относится отправка.
bodystringБолее длинное описание.
namestringОтображаемое имя конечного пользователя.
localestringЯзык отправляемых уведомлений (en, ar, de, es, fr, he, hi, it, ja, ru, zh). По умолчанию en.
curl -X POST https://api.supdesk.app/v1/submissions \ -H "Authorization: Bearer sd_live_..." \ -H "Content-Type: application/json" \ -d '{ "type": "bug", "title": "Export button unresponsive on Safari", "email": "jamie@example.com", "body": "Clicking Export does nothing on Safari 26." }'

Возвращает 201 с созданной отправкой. Конечный пользователь создается (или сопоставляется по email) в вашем списке клиентов автоматически.

Созданные отправки учитываются в вашем месячном лимите отправок точно так же, как отправки из портала. На пределе этот конечный пункт возвращает 429 limit_reached — если ваше рабочее пространство включило переплату за отправки, отправка принимается и оплачивается. Смотрите Лимиты запросов и использование.

Last updated on