Class Organization

Hierarchy

  • BaseOrganization
    • Organization

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

  • Creates a new team in an existing organization.

    Required scope

    organizations:teams:write

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#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

    Returns Promise<Team>

getAllOrganizationMembers

  • 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>

getAllTeams

  • 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>

getDataClassification

  • Retrieves board classification settings for an existing organization.

    Required scope

    organizations:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#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>

getDefaultTeamSettings

  • Retrieves default team settings of an existing organization.

    Required scope

    organizations:teams:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#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>

getOrganizationMember

  • Retrieves organization member information for an existing organization.

    Required scope

    organizations:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#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>

getTeam

  • Retrieves team information for an existing team.

    Required scope

    organizations:teams:read

    Rate limiting

    <a target=_blank href="/docs/miro-rest-api-introduction#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>

@mirohq/miro-api