jira.js
    Preparing search index...

    Function getEvents

    • 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.

      Authorization scopes required: read:events:admin

      Parameters

      • client: Client
      • parameters: {
            action?: string;
            actor?: string[];
            cursor?: string;
            from?: string;
            ip?: string[];
            limit?: number;
            location?: string;
            orgId: string;
            product?: (
                | "jira"
                | string & {}
                | "confluence"
                | "bitbucket"
                | "guard_detect"
                | "loom"
            )[];
            q?: string;
            to?: string;
        }
        • Optionalaction?: string

          A query filter that returns events of a specific action type.

        • Optionalactor?: string[]

          A query filter that returns events by one or more specific actors.

        • Optionalcursor?: string

          Sets the starting point for the page of results to return

        • Optionalfrom?: string

          The earliest date and time of the event represented as a UNIX epoch time in milliseconds.

        • Optionalip?: string[]

          A query filter that returns events by one or more specific ip addresses.

        • Optionallimit?: number

          The maximum number of events to return per page.

        • Optionallocation?: string

          A query filter that returns events by one or more specific locations. Of format: [ { "city": "", "countryName": "" }, ... ]

        • orgId: string

          Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.

        • Optionalproduct?: ("jira" | string & {} | "confluence" | "bitbucket" | "guard_detect" | "loom")[]

          A query filter that returns events by one or more specific products.

        • Optionalq?: string

          Single query term for searching events.

        • Optionalto?: string

          The latest date and time of the event represented as a UNIX epoch time in milliseconds.

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              data?: {
                  attributes: {
                      action: string;
                      actor: {
                          app?: {
                              attributes?: Record<(...), (...)>;
                              id: string;
                              type?: string;
                              [key: string]: unknown;
                          };
                          auth?: {
                              authType: | (...) & (...)
                              | "container-token"
                              | "api-token"
                              | "connect-token"
                              | "auth-token-for-2LO"
                              | "auth-token-for-3LO";
                              tokenId?: string;
                              tokenLabel?: string;
                              [key: string]: unknown;
                          };
                          email?: string;
                          id: string;
                          links?: { self: string
                          | null; [key: string]: unknown };
                          name?: string;
                          onBehalfOf?: {
                              email?: string;
                              id: string;
                              name?: string;
                              [key: string]: unknown;
                          };
                          [key: string]: unknown;
                      };
                      container?: {
                          attributes?: Record<(...), (...)>;
                          id: string;
                          links?:
                              | { alt?: ...; self?: ...; [key: ...]: ... }
                              | { alt: ...; [key: ...]: ... };
                          type?: string;
                          [key: string]: unknown;
                      }[];
                      context: {
                          attributes?: Record<string, any>;
                          id: string;
                          links?:
                              | {
                                  alt?: (...)
                                  | (...);
                                  self?: (...) | (...) | (...);
                                  [key: string]: unknown;
                              }
                              | { alt: string; [key: string]: unknown };
                          type?: string;
                          [key: string]: unknown;
                      }[];
                      location?: {
                          city?: string;
                          countryName?: string;
                          geo?: string;
                          ip?: string;
                          regionName?: string;
                          [key: string]: unknown;
                      };
                      time: Date;
                      [key: string]: unknown;
                  };
                  id: string;
                  links: { self: string
                  | null; [key: string]: unknown };
                  message?: { content?: string; format?: string; [key: string]: unknown };
                  type: string & {} | "events";
                  [key: string]: unknown;
              }[];
              links?: {
                  next?: string
                  | null;
                  prev?: string | null;
                  self?: string | null;
                  [key: string]: unknown;
              };
              meta?: {
                  attributes?: unknown;
                  count?: number;
                  current?: number;
                  end_index?: number;
                  next?: string
                  | null;
                  page_size?: number;
                  prev?: string;
                  start_index?: number;
                  total?: number;
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility

    On This Page
    Scopes