Function: getEvents()

function getEvents(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  data?: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
  meta?: {
   [key: string]: unknown;
     attributes?: unknown;
     count?: number;
     current?: number;
     end_index?: number;
     next?: string | null;
     page_size?: number;
     prev?: string;
     start_index?: number;
     total?: number;
  };
}>;

Defined in: src/admin/api/events.ts:30

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.

Scopes

Authorization scopes required: read:events:admin

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ action?: string; actor?: string[]; cursor?: string; from?: string; ip?: string[]; limit?: number; location?: string; orgId: string; product?: ( | "jira" | string & object | "confluence" | "bitbucket" | "guard_detect" | "loom")[]; q?: string; to?: string; }	-
parameters.action?	string	A query filter that returns events of a specific action type.
parameters.actor?	string[]	A query filter that returns events by one or more specific actors.
parameters.cursor?	string	Sets the starting point for the page of results to return
parameters.from?	string	The earliest date and time of the event represented as a UNIX epoch time in milliseconds.
parameters.ip?	string[]	A query filter that returns events by one or more specific ip addresses.
parameters.limit?	number	The maximum number of events to return per page.
parameters.location?	string	A query filter that returns events by one or more specific locations. Of format: [ { "city": "<CityName>", "countryName": "<CountryName>" }, ... ]
parameters.orgId?	string	Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
parameters.product?	( | "jira" | string & object | "confluence" | "bitbucket" | "guard_detect" | "loom")[]	A query filter that returns events by one or more specific products.
parameters.q?	string	Single query term for searching events.
parameters.to?	string	The latest date and time of the event represented as a UNIX epoch time in milliseconds.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; data?: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; meta?: { [key: string]: unknown; attributes?: unknown; count?: number; current?: number; end_index?: number; next?: string | null; page_size?: number; prev?: string; start_index?: number; total?: number; }; }>