Class Organization

Hierarchy

BaseOrganization
- Organization

Index

Properties

fullLicensesPurchased id name plan type?

Methods

createTeam getAllOrganizationMembers getAllTeams getDataClassification getDefaultTeamSettings getOrganizationMember getTeam

Properties

fullLicensesPurchased

fullLicensesPurchased: number

Purchased FULL licenses

id

id: string

name

name: string

Name of the organization

plan

plan: string

Organization plan type

`Optional` type

type?: string = 'organization'

Type of the object returned.

Methods

createTeam

createTeam(createTeamRequest: CreateTeamRequest): Promise<Team>
Creates a new team in an existing organization.
Required scope
organizations:teams:write
Rate limiting
Level 1
Enterprise only

This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

Summary
Create team
Parameters
- createTeamRequest: CreateTeamRequest
Returns Promise<Team>
- Defined in highlevel/index.ts:116

getAllOrganizationMembers

getAllOrganizationMembers(query: Omit<undefined | {
    active?: boolean;
    cursor?: string;
    emails?: string;
    license?: "unknown" | "full" | "occasional" | "free" | "free_restricted" | "full_trial";
    limit?: number;
    role?: "unknown" | "organization_internal_admin" | "organization_internal_user" | "organization_external_user" | "organization_team_guest_user";
}, "offset">): AsyncGenerator<OrganizationMember, void, unknown>
Retrieves organization members based on the organization ID and the cursor, or based on the user emails provided in the request.
Required scope
organizations:read
Rate limiting
Level 3
Enterprise only

This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users.

Returns an iterator which will automatically paginate and fetch all available resources

Summary
Get organization members
Parameters
- query: Omit<undefined | {
      active?: boolean;
      cursor?: string;
      emails?: string;
      license?: "unknown" | "full" | "occasional" | "free" | "free_restricted" | "full_trial";
      limit?: number;
      role?: "unknown" | "organization_internal_admin" | "organization_internal_user" | "organization_external_user" | "organization_team_guest_user";
  }, "offset">
  
  query to be used for organization members retrieval
Returns AsyncGenerator<OrganizationMember, void, unknown>
Inherited from BaseOrganization.getAllOrganizationMembers
- Defined in highlevel/Organization.ts:16

getAllTeams

getAllTeams(query: undefined | {
    cursor?: string;
    limit?: number;
    name?: string;
}): AsyncGenerator<Team, void, unknown>
Retrieves list of all teams in an existing organization.
Required scope
organizations:teams:read
Rate limiting
Level 1
Enterprise only

This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users.

Returns an iterator which will automatically paginate and fetch all available resources

Summary
List teams
Parameters
- query: undefined | {
      cursor?: string;
      limit?: number;
      name?: string;
  }
Returns AsyncGenerator<Team, void, unknown>
Inherited from BaseOrganization.getAllTeams
- Defined in highlevel/Organization.ts:42

getDataClassification

getDataClassification(): Promise<DataClassification>
Retrieves board classification settings for an existing organization.
Required scope
organizations:read
Rate limiting
Level 2
Enterprise only

This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

Summary
Get organization settings

Returns Promise<DataClassification>
- Defined in highlevel/index.ts:126

getDefaultTeamSettings

getDefaultTeamSettings(): Promise<TeamSettings>
Retrieves default team settings of an existing organization.
Required scope
organizations:teams:read
Rate limiting
Level 1
Enterprise only

This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

Summary
Get default team settings

Returns Promise<TeamSettings>
- Defined in highlevel/index.ts:136

getOrganizationMember

getOrganizationMember(memberId: string): Promise<OrganizationMember>
Retrieves organization member information for an existing organization.
Required scope
organizations:read
Rate limiting
Level 3
Enterprise only

This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

Summary
Get organization member
Parameters
- memberId: string
  
  id of the organization member
Returns Promise<OrganizationMember>
- Defined in highlevel/index.ts:147

getTeam

getTeam(teamId: string): Promise<Team>
Retrieves team information for an existing team.
Required scope
organizations:teams:read
Rate limiting
Level 1
Enterprise only

This API is available only for <a target=_blank href="/reference/api-reference#enterprise-plan">Enterprise plan users. You can only use this endpoint if you have the role of a Company Admin. You can request temporary access to Enterprise APIs using <a target=_blank href="https://miro-survey.typeform.com/to/BVPTNWJ9\">this form.

Summary
Get team
Parameters
- teamId: string
  
  The id of the Team.
Returns Promise<Team>
- Defined in highlevel/index.ts:160

Class Organization

Hierarchy

Index

Properties

Methods

Properties

fullLicensesPurchased

id

name

plan

Optional type

Methods

createTeam

Required scope

Rate limiting

Enterprise only

Summary

Parameters

createTeamRequest: CreateTeamRequest

Returns Promise<Team>

getAllOrganizationMembers

Required scope

Rate limiting

Enterprise only

Summary

Parameters

Returns AsyncGenerator<OrganizationMember, void, unknown>

getAllTeams

Required scope

Rate limiting

Enterprise only

Summary

Parameters

query: undefined | { cursor?: string; limit?: number; name?: string; }

Returns AsyncGenerator<Team, void, unknown>

getDataClassification

Required scope

Rate limiting

Enterprise only

Summary

Returns Promise<DataClassification>

getDefaultTeamSettings

Required scope

Rate limiting

Enterprise only

Summary

Returns Promise<TeamSettings>

getOrganizationMember

Required scope

Rate limiting

Enterprise only

Summary

Parameters

memberId: string

Returns Promise<OrganizationMember>

getTeam

Required scope

Rate limiting

Enterprise only

Summary

Parameters

teamId: string

Returns Promise<Team>

`Optional` type

query: undefined | {
cursor?: string;
limit?: number;
name?: string;
}