Skip to main content
GET
/
v0
/
organisation
/
{org_id}
/
events
List organisation audit events
curl --request GET \
  --url https://sis.sumvin.com/v0/organisation/{org_id}/events \
  --header 'Authorization: Bearer <token>'
{
  "_links": {
    "self": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    },
    "organisation": {
      "href": "<string>",
      "method": "GET",
      "templated": false,
      "description": "<string>"
    }
  },
  "events": [
    {
      "id": "<string>",
      "actor_type": "<string>",
      "resource_type": "<string>",
      "created_at": 123,
      "event_type": "<string>",
      "actor_key_id": "<string>",
      "resource_id": "<string>",
      "actor": {
        "type": "member",
        "id": "<string>",
        "email": "<string>",
        "name": "<string>",
        "deleted_at": 123
      },
      "resource": {
        "type": "organisation",
        "id": "<string>",
        "name": "<string>",
        "deleted_at": 123
      },
      "metadata": {
        "name": "<string>"
      }
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

org_id
string
required

Query Parameters

event_type
string | null

Filter by event type (e.g. key_created)

resource_type
string | null

Filter by resource type (e.g. environment)

actor_type
string | null

Filter by actor type: member or api_key

period_start
integer | null

Earliest event time (ms since epoch, inclusive)

period_end
integer | null

Latest event time (ms since epoch, inclusive)

cursor
string | null

Pagination cursor: the next_cursor from the previous page

limit
integer
default:50

Events per page (1-200, default 50)

Required range: 1 <= x <= 200
expand
enum<string>[]

Expand related entities inline on each event. Pass 'actor' to receive the member or API key that emitted the event as a typed object under actor. Pass 'resource' to receive the entity the event acted upon as a typed object under resource. Repeatable. When omitted, actor and resource are null on every event.

Available options:
actor,
resource

Response

Successful Response

events
(OrgCreatedEvent · object | OrgUpdatedEvent · object | MemberInvitedEvent · object | MemberUpdatedEvent · object | MemberRemovedEvent · object | KeyCreatedEvent · object | KeyRevokedEvent · object | EnvCreatedEvent · object | EnvUpdatedEvent · object | EnvDeletedEvent · object | AuthConfigCreatedEvent · object | AuthConfigUpdatedEvent · object | AuthConfigDeletedEvent · object | UnknownAuditEvent · object)[]
required
has_more
boolean
required
next_cursor
string | null