jira.js
    Preparing search index...

    Function getOrgById

    • Returns information about a single organization by ID

      Authorization scopes required: read:orgs:admin

      Parameters

      • client: Client
      • parameters: { orgId: string }
        • orgId: string

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

      • Optionaloptions: RequestOptions

      Returns Promise<
          {
              data?: {
                  attributes: { name?: string; [key: string]: unknown };
                  id: string;
                  links: { self: string | null; [key: string]: unknown };
                  relationships: {
                      domains?: {
                          links?: { related: string; [key: string]: unknown };
                          related?: string;
                          [key: string]: unknown;
                      };
                      users?: {
                          links?: { related: string; [key: string]: unknown };
                          related?: string;
                          [key: string]: unknown;
                      };
                      [key: string]: unknown;
                  };
                  type: string & {}
                  | "orgs";
                  [key: string]: unknown;
              };
              [key: string]: unknown;
          },
      >

    Settings
    Member Visibility

    On This Page
    Scopes