An organization in Mix is the parent entity that contains members, projects, applications, environments, deployment flows, and associated credentials.

Users are members of two or more organizations. There are two types of organizations:

  • Personal: This is a user’s personal organization and is specified with the user’s email address. All users own a personal organization, which includes a sample application (Mix Sample App), a sandbox environment, a deployment flow, as well as trial credentials.
  • Standard: A standard organization groups users with a specific email domain. In addition to their personal organization, every user is part of a standard organization that is represented by the business email domain. A standard organization often represents a company, university, and so on. Nuance can also create other standard organizations for a customer. The organization owner can then manage the organization.

For example:

Personal organization: ""
Standard organization: "Mix.api Test Organization"

Some of the functionality is controlled at the organization level. This includes, for example, access to prebuilt domains, voice packs and language topics available, and more. Users also have a role inside an organization.

By default, the following roles are available at the organization level:

  • Owner: Can invite users, edit organization details, and create projects.
  • Member: Can see the organization details and collaborate on projects/applications.
  • Viewer: Can see the organization details, projects, and applications, but cannot edit them.
  • Expert: Can access advanced platform capabilities, such as importing rule-based grammars.
  • Promotion approver: Can approve promotions of deployments in the organization.
  • Pro services (PS): Can access advanced platform capabilities such as admin portal or allowing approval of specific Dialog or NLU projects, as well as manage credentials.

The different organization types as well as user roles determine the permissions that are available in terms of projects, applications, tools (such Mix.dialog and Mix.nlu), and so on.

Some examples:

  • When a project is created in an organization, it is shared with all the members in this organization.
  • If a user is not part of the organization in which a project is created, this user will not see the project. To share a project with a user that is not in your organization, you must add that user as a member of the project.
  • A user with a viewer role can see the Mix.nlu and Mix.dialog data for a project, but cannot edit them.

Get organizations

GET /v4/organizations

Retrieve the list of organizations that correspond to the query criteria specified.


Status Meaning Description Schema
200 OK List of organizations mix.api.ListOrganizationsResponse
401 Unauthorized Request could not be authorized Inline
500 Internal Server Error Internal server error Inline
default Default An unexpected error response. grpc.gateway.runtime.Error

Example responses

  200 response