Skip to main content
GET
/
v1
/
organizations
/
audit-events
Get Organization Audit Events
curl --request GET \
  --url https://sandbox-api.borderless.xyz/v1/organizations/audit-events \
  --header 'Authorization: Bearer <token>'
{
  "hasMore": true,
  "data": [
    {
      "id": "<string>",
      "action": "<string>",
      "metadata": {},
      "actor": {
        "name": "<string>",
        "email": "<string>"
      },
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
category
enum<string>

Filter by event category.

Available options:
Credentials,
Routing,
Network
​
actorType
enum<string>

Filter by actor type.

Available options:
DashboardUser,
ApiToken,
Admin
​
action
string

Filter by exact action key.

​
from
string

Only events at or after this ISO date-time.

​
to
string

Only events at or before this ISO date-time.

​
search
string

Free-text search over action and actor email.

​
startingAfter
string

Id used to retrieve results that come after the specified item.

​
limit
number

Response page limit. Min 1, Max 100, Default value is 10.

Response

200 - application/json

List of Organization Audit Events and hasMore flag.

​
hasMore
boolean
required
​
data
object[]
required