Function: getOrgById()

function getOrgById(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  data?: {
   [key: string]: unknown;
     attributes: {
      [key: string]: unknown;
        name?: string;
     };
     id: string;
     links: {
      [key: string]: unknown;
        self: string | null;
     };
     relationships: {
      [key: string]: unknown;
        domains?: {
         [key: string]: unknown;
           links?: {
            [key: string]: unknown;
              related: string;
           };
           related?: string;
        };
        users?: {
         [key: string]: unknown;
           links?: {
            [key: string]: unknown;
              related: string;
           };
           related?: string;
        };
     };
     type: string & object | "orgs";
  };
}>;

Defined in: src/admin/api/orgs.ts:29

Returns information about a single organization by ID

Scopes

Authorization scopes required: read:orgs:admin

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ orgId: string; }	-
parameters.orgId	string	Your organization has a unique ID. Find this ID in your Atlassian Administration URL or when you create your API key.
options?	RequestOptions	-

Returns

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