• Orgs
  • Users
  • Groups
  • Domains
  • Events
  • Policies
  • Directory
  • Workspaces
Cloud
Organizations REST API / Reference / REST API

Events

Postman Collection
OpenAPI
GET

Query audit log events

Returns a filtered list of audit log events for an organization. Use this endpoint for more granular and detailed querying. If you simply need to paginate through all events, consider using the /events-stream endpoint.
These rate limits for this endpoint be lowered effective end of May 2025 as follows:

  • Rate limit per user: 10 requests per minute
  • Rate limit per API path: 10 requests per minute

Please migrate to the polling API to guarantee uninterrupted service for use cases involving a high request rate.

Request

Path parameters

orgId

string

Required

Query parameters

cursor

string

q

string

from

string

to

string

action

string

actor

array<string>

ip

array<string>

product

array<string>

location

string

limit

integer

Responses

Successful operation

application/json

EventPage
GET/v1/orgs/{orgId}/events
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/events' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 { "data": [ { "id": "<string>", "type": "events", "attributes": { "time": "2025-02-27T18:50:12.281Z", "action": "<string>", "actor": { "id": "<string>", "name": "<string>", "email": "<string>", "auth": { "authType": "container-token", "tokenId": "<string>", "tokenLabel": "<string>" }, "onBehalfOf": { "id": "<string>", "name": "<string>", "email": "<string>" }, "links": { "self": "<string>" } }, "context": [ { "id": "<string>", "type": "<string>", "attributes": {}, "links": { "self": "<string>", "alt": "<string>" } } ], "container": [ { "id": "<string>", "type": "<string>", "attributes": {}, "links": { "self": "<string>", "alt": "<string>" } } ], "location": { "ip": "<string>", "geo": "<string>", "countryName": "<string>", "regionName": "<string>", "city": "<string>" } }, "links": { "self": "<string>" }, "message": { "content": "<string>", "format": "<string>" } } ], "meta": { "next": "<string>", "page_size": 25 }, "links": { "self": "<string>", "prev": "<string>", "next": "<string>" } }
GET

Poll audit log events

Returns a paginated list of audit logs events for an organization. Use this endpoint if you want to retrieve events in a simple, paginated manner with time-based filtering. If you need more advanced filtering, refer to the /events endpoint.

Request

Path parameters

orgId

string

Required

Query parameters

cursor

string

from

string

to

string

limit

integer

sortOrder

string

Responses

Successful operation

application/json

PollingEventPage
GET/v1/orgs/{orgId}/events-stream
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/events-stream' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 { "data": [ { "id": "<string>", "type": "events", "attributes": { "time": "2025-02-27T18:50:12.281Z", "processedAt": "2025-02-27T18:50:12.281Z", "action": "<string>", "actor": { "id": "<string>", "name": "<string>", "email": "<string>", "auth": { "authType": "container-token", "tokenId": "<string>", "tokenLabel": "<string>" }, "onBehalfOf": { "id": "<string>", "name": "<string>", "email": "<string>" }, "links": { "self": "<string>" } }, "context": [ { "id": "<string>", "type": "<string>", "attributes": {}, "links": { "self": "<string>", "alt": "<string>" } } ], "container": [ { "id": "<string>", "type": "<string>", "attributes": {}, "links": { "self": "<string>", "alt": "<string>" } } ], "location": { "ip": "<string>", "geo": "<string>", "countryName": "<string>", "regionName": "<string>", "city": "<string>" } }, "links": { "self": "<string>" }, "message": { "content": "<string>", "format": "<string>" } } ], "meta": { "next": "<string>", "page_size": 26 }, "links": { "self": "<string>", "prev": "<string>", "next": "<string>" } }
GET

Get an event by ID

Returns information about a single event by ID.

Request

Path parameters

orgId

string

Required
eventId

string

Required

Responses

Successful operation

application/json

Event
GET/v1/orgs/{orgId}/events/{eventId}
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/events/{eventId}' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 { "data": { "id": "<string>", "type": "events", "attributes": { "time": "2025-02-27T18:50:12.281Z", "action": "<string>", "actor": { "id": "<string>", "name": "<string>", "email": "<string>", "auth": { "authType": "container-token", "tokenId": "<string>", "tokenLabel": "<string>" }, "onBehalfOf": { "id": "<string>", "name": "<string>", "email": "<string>" }, "links": { "self": "<string>" } }, "context": [ { "id": "<string>", "type": "<string>", "attributes": {}, "links": { "self": "<string>", "alt": "<string>" } } ], "container": [ { "id": "<string>", "type": "<string>", "attributes": {}, "links": { "self": "<string>", "alt": "<string>" } } ], "location": { "ip": "<string>", "geo": "<string>", "countryName": "<string>", "regionName": "<string>", "city": "<string>" } }, "links": { "self": "<string>" }, "message": { "content": "<string>", "format": "<string>" } } }
GET

Get list of event actions

Returns information localized event actions

Request

Path parameters

orgId

string

Required

Responses

Successful operation

application/json

EventActions
GET/v1/orgs/{orgId}/event-actions
1 2 3 4 curl --request GET \ --url 'https://api.atlassian.com/admin/v1/orgs/{orgId}/event-actions' \ --header 'Authorization: Bearer <access_token>' \ --header 'Accept: application/json'
200Response
1 2 3 4 5 6 7 8 9 10 11 12 { "data": [ { "id": "<string>", "type": "<string>", "attributes": { "displayName": "<string>", "groupDisplayName": "<string>" } } ] }

Rate this page: