Function: getOrgs()

function getOrgs(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  data?: object[];
  links?: {
   [key: string]: unknown;
     next?: string | null;
     prev?: string | null;
     self?: string | null;
  };
  meta?: unknown;
}>;

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

Returns a list of your organizations (based on your API key).

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ cursor?: string; }	-
parameters.cursor?	string	Sets the starting point for the page of results to return.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; data?: object[]; links?: { [key: string]: unknown; next?: string | null; prev?: string | null; self?: string | null; }; meta?: unknown; }>