Skip to main content

Function: getOrg()

getOrg(client, props): Promise<{ id: number; name: string; description: string; visibility: "PRIVATE" | "PUBLIC"; location: string; createdAt: string; updatedAt: string; isPersonalOrg: boolean; socialLinks: object[]; }>

Gets organization information by name.

Parameters​

client​

ApiClient

The API client instance

props​

The request properties

params​

{ orgName: string; } = getOrgParamsSchema

Path parameters (orgName)

params.orgName​

string = orgNameSchema

Returns​

Promise<{ id: number; name: string; description: string; visibility: "PRIVATE" | "PUBLIC"; location: string; createdAt: string; updatedAt: string; isPersonalOrg: boolean; socialLinks: object[]; }>

Promise resolving to the organization information

Operation Id​

get-org

Example​

const org = await getOrg(client, {
  params: { orgName: 'my-org' }
});