Перейти к содержимому
Holst
Русский
Esc
навигацияоткрыть⌘Jпредпросмотр

Получить события аудита

Возвращает список событий аудита организации. Требуется персональный токен доступа со скоупом organization:audit_events_read. Владелец токена должен быть администратором организации.

GET/v1/organizations/{organizationId}/audit_events
Authorization
AuthorizationBearer token (holst_pat_...) · headerrequired

Персональный токен доступа Holst, передаваемый в заголовке Authorization в формате Bearer holst_pat_....

Path parameters
organizationIdstring<uuid>required

Идентификатор организации, для которой нужно вернуть события аудита.

Query parameters
actionTypesstring[]

Типы действий, которые нужно включить. Передайте несколько значений через запятую. Если параметр не указан, возвращаются события всех типов.

startTimestring<date-time>

Самое раннее время события в формате RFC 3339. Граница включается в выборку. Если параметр не указан, нижняя временная граница не применяется.

endTimestring<date-time>

Самое позднее время события в формате RFC 3339. Граница включается в выборку и не может быть раньше startTime. Если параметр не указан, верхняя временная граница не применяется. Для стабильной конечной выгрузки в порядке возрастания задайте endTime и не меняйте его при переходе между страницами.

pageSizeinteger

Максимальное количество событий на странице.

min 1 · max 1000 · default: 100
orderstring

Направление сортировки событий по occurredAt, затем по id.

default: "desc"
Allowed:ascdesc
cursorstring

Курсор пагинации из поля nextCursor предыдущего ответа. Курсор непрозрачен, обозначает только позицию и не сохраняет параметры запроса. При получении следующей страницы используйте те же фильтры и порядок сортировки. Их изменение может привести к пропуску или повторному получению событий.

Responses
200

Страница событий аудита организации.

auditEventsAuditEvent[]required

События аудита в запрошенном порядке сортировки.

Show properties
Array of AuditEvent
idstringrequired
occurredAtstring<date-time>required
actionAuditEventActionrequired
Show properties
typestringrequired

Расширяемый идентификатор действия.

detailsobjectrequired

Метаданные действия, набор полей которых зависит от action.type.

actorAuditEventActorrequired
Show properties
typestringrequired

Тип инициатора: user, anonymous, system или unknown.

idstringrequired
namestring
emailstring
contextAuditEventContextrequired
Show properties
requestIdstring
sessionIdstring
requestIpstring
scopeAuditEventScoperequired
Show properties
organizationIdstringrequired
workspaceIdstring
workspaceNamestring
channelIdstring
entityAuditEventEntityrequired
Show properties
typestring

Тип объекта: channel, workspace, organization или user.

subtypestring
idstring
namestring
emailstring
nextCursorstring

Курсор для получения следующей страницы. Отсутствует, если больше событий нет.

400

Некорректный запрос.

errCodestringrequired

Машиночитаемый код ошибки.

msgstringrequired

Понятное человеку сообщение об ошибке.

varsobject | nullrequired

Структурированные значения, связанные с ошибкой, или null.

401

Данные аутентификации отсутствуют или недействительны.

errCodestringrequired

Машиночитаемый код ошибки.

msgstringrequired

Понятное человеку сообщение об ошибке.

varsobject | nullrequired

Структурированные значения, связанные с ошибкой, или null.

403

У аутентифицированного клиента нет прав на выполнение операции.

errCodestringrequired

Машиночитаемый код ошибки.

msgstringrequired

Понятное человеку сообщение об ошибке.

varsobject | nullrequired

Структурированные значения, связанные с ошибкой, или null.

429

Аутентифицированный пользователь превысил ограничение частоты запросов.

errCodestringrequired

Машиночитаемый код ошибки.

msgstringrequired

Понятное человеку сообщение об ошибке.

varsobject | nullrequired

Структурированные значения, связанные с ошибкой, или null.

500

При обработке запроса произошла непредвиденная ошибка.

errCodestringrequired

Машиночитаемый код ошибки.

msgstringrequired

Понятное человеку сообщение об ошибке.

varsobject | nullrequired

Структурированные значения, связанные с ошибкой, или null.

Request
curl -X GET "https://api.holst.so/v1/organizations/497f6eca-6276-4993-bfeb-53cbbbba6f08/audit_events" \
  -H "Authorization: Bearer YOUR_TOKEN"
Response
{
  "auditEvents": [
    {
      "id": "46b44beb-b585-4598-a241-6bacea128799",
      "occurredAt": "2026-08-31T09:20:35.213Z",
      "action": {
        "type": "workspace_create",
        "details": {
          "fields": {
            "name": "Маркетинг"
          }
        }
      },
      "actor": {
        "type": "user",
        "id": "87736cf6-ca84-4519-8fc2-81c815b76c63",
        "name": "Иван Петров",
        "email": "ivan@example.com"
      },
      "context": {
        "requestId": "4f7f8a01-3a71-42f9-b7b2-71dca2cb55c8",
        "sessionId": "c192570a-3c98-464f-9e78-0cee7fddc864",
        "requestIp": "203.0.113.10"
      },
      "scope": {
        "organizationId": "d311fcba-32ba-417c-aabb-221a819f2ea4",
        "workspaceId": "069018a1-f7ae-42f7-adc7-d6684364abca",
        "workspaceName": "Маркетинг"
      },
      "entity": {
        "type": "workspace",
        "id": "069018a1-f7ae-42f7-adc7-d6684364abca",
        "name": "Маркетинг"
      }
    }
  ]
}