Skip to content

Function: getServiceDeskOrganizations() ​

ts
function getServiceDeskOrganizations(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  _expands?: string[];
  _links?: {
   [key: string]: unknown;
     base?: string;
     context?: string;
     next?: string;
     prev?: string;
     self?: string;
  };
  isLastPage?: boolean;
  limit?: number;
  size?: number;
  start?: number;
  values?: object[];
}>;

Defined in: src/serviceDesk/api/organization.ts:324

This method returns a list of all organizations associated with a service desk.

Permissions required: Service desk's agent.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ accountId?: string; limit?: number; serviceDeskId: string; start?: number; }-
parameters.accountId?stringThe account ID of the user, which uniquely identifies the user across all Atlassian products. For example, 5b10ac8d82e05b22cc7d4ef5.
parameters.limit?numberThe maximum number of items to return per page. Default: 50. See the Pagination section for more details.
parameters.serviceDeskId?stringThe ID of the service desk from which the organization list will be returned. This can alternatively be a project identifier.
parameters.start?numberThe starting index of the returned objects. Base index: 0. See the Pagination section for more details.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; _expands?: string[]; _links?: { [key: string]: unknown; base?: string; context?: string; next?: string; prev?: string; self?: string; }; isLastPage?: boolean; limit?: number; size?: number; start?: number; values?: object[]; }>