Nuance Organizations API
The Organizations API from Nuance — 1 operation(s) for organizations.
The Organizations API from Nuance — 1 operation(s) for organizations.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/nuance:nuance-organizations-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Mix.api Specification Organizations API
version: 26.1026.216
security:
- OAuth2:
- mix-api
bearerAuth: []
tags:
- name: Organizations
paths:
/v4/organizations:
get:
summary: Get organizations
description: Retrieve the list of organizations that correspond to the query criteria specified.
operationId: MixAPI_ListOrganizations
responses:
'200':
description: List of organizations
content:
application/json:
schema:
type: array
$ref: '#/components/schemas/mix.api.ListOrganizationsResponse'
'401':
description: Request could not be authorized
content:
application/json:
schema: {}
'500':
description: Internal server error
content:
application/json:
schema: {}
default:
description: An unexpected error response.
content:
application/json:
schema:
$ref: '#/components/schemas/grpc.gateway.runtime.Error'
parameters:
- name: type
description: "Type of organizations to return.\n\n - TYPE_UNSPECIFIED: All types of organizations\n - PERSONAL: User's personal organization, identified with the user's email address\n - STANDARD: Global organization, such as a company, that typically includes many members"
in: query
required: false
schema:
type: string
enum:
- TYPE_UNSPECIFIED
- PERSONAL
- STANDARD
default: TYPE_UNSPECIFIED
- name: view
description: "Organization view to return.\n\n - VIEW_UNSPECIFIED: Returns organization details without listing the organization members\n - FULL: Returns all organization details, including the list of organization members"
in: query
required: false
schema:
type: string
enum:
- VIEW_UNSPECIFIED
- FULL
default: VIEW_UNSPECIFIED
- name: showAll
description: When set to true, shows all existing organizations. This flag requires specific permissions; while it is visible to all users, it will be enabled only for users with these permissions.
in: query
required: false
schema:
type: boolean
- name: limit
description: Maximum number of query results returned.
in: query
required: false
schema:
type: integer
format: int32
- name: offset
description: Offset to use when returning results.
in: query
required: false
schema:
type: integer
format: int32
- name: sortBy
description: 'Sort parameter; use the format: +id.'
in: query
required: false
style: form
explode: true
schema:
type: array
items:
type: string
- name: filter
description: 'Filter results parameter: can be organization ID or organization display name. The search is case sensitive.'
in: query
required: false
schema:
type: string
- name: includeShared
description: When set to true, also returns the organizations that contain projects to which the user has access.
in: query
required: false
schema:
type: boolean
tags:
- Organizations
components:
schemas:
google.protobuf.Any:
type: object
properties:
type_url:
type: string
description: "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n URL, or have them precompiled into a binary to avoid any\n lookup. Therefore, binary compatibility needs to be preserved\n on changes to types. (Use versioned type names to manage\n breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com. As of May 2023, there are no widely used type server\nimplementations and no plans to implement one.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
value:
type: string
format: byte
description: Must be a valid serialized protocol buffer of the above specified type.
description: "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n Foo foo = ...;\n Any any;\n any.PackFrom(foo);\n ...\n if (any.UnpackTo(&foo)) {\n ...\n }\n\nExample 2: Pack and unpack a message in Java.\n\n Foo foo = ...;\n Any any = Any.pack(foo);\n ...\n if (any.is(Foo.class)) {\n foo = any.unpack(Foo.class);\n }\n // or ...\n if (any.isSameTypeAs(Foo.getDefaultInstance())) {\n foo = any.unpack(Foo.getDefaultInstance());\n }\n\n Example 3: Pack and unpack a message in Python.\n\n foo = Foo(...)\n any = Any()\n any.Pack(foo)\n ...\n if any.Is(Foo.DESCRIPTOR):\n any.Unpack(foo)\n ...\n\n Example 4: Pack and unpack a message in Go\n\n foo := &pb.Foo{...}\n any, err := anypb.New(foo)\n if err != nil {\n ...\n }\n ...\n foo := &pb.Foo{}\n if err := any.UnmarshalTo(foo); err != nil {\n ...\n }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n package google.profile;\n message Person {\n string first_name = 1;\n string last_name = 2;\n }\n\n {\n \"@type\": \"type.googleapis.com/google.profile.Person\",\n \"firstName\": <string>,\n \"lastName\": <string>\n }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n {\n \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n \"value\": \"1.212s\"\n }"
mix.api.ListOrganizationsResponse:
type: object
example:
organizations:
- id: '233'
displayName: Mix.api Test Organization
type: STANDARD
members:
- member:
id: '36'
email: alex.smith@company.com
name: Alex Smith
createTime: '2020-01-16T15:44:25.231Z'
lastLoginTime: '2021-01-26T13:07:16.644Z'
roles:
- id: '2'
displayName: member
description: Can see the organization details and collaborate on projects/applications.
isDeepLearningModelEnabled: true
isEnginePacksEnabled: false
isDataPacksEnabled: false
- id: '37'
displayName: alex.smith@company.com
type: PERSONAL
members:
- member:
id: '36'
email: alex.smith@company.com
name: Alex Smith
createTime: '2020-01-16T15:44:25.231Z'
lastLoginTime: '2021-01-26T13:07:16.644Z'
roles:
- id: '1'
displayName: owner
description: Can invite users, edit organization details, and create projects and applications.
isDeepLearningModelEnabled: false
isEnginePacksEnabled: true
isDataPacksEnabled: false
totalSize: 1
count: 1
limit: 0
offset: 0
properties:
organizations:
type: array
items:
$ref: '#/components/schemas/mix.api.Organization'
description: List of organizations.
totalSize:
type: integer
format: int32
description: Total number of organizations that match the request.
count:
type: integer
format: int32
description: Number of results returned.
limit:
type: integer
format: int32
description: Value of limit field specified in request.
offset:
type: integer
format: int32
description: Value of offset field specified in request.
description: Response object returned by the Get Organizations list request.
mix.api.OrganizationRole:
type: object
properties:
id:
type: string
description: Unique ID identifying the role.
displayName:
type: string
description: Name of the role.
description:
type: string
description: Description of the role.
description: Message that defines the roles available in an organization.
mix.api.Organization:
type: object
properties:
id:
type: string
description: Unique ID identifying the organization.
displayName:
type: string
description: Name of the organization.
type:
$ref: '#/components/schemas/mix.api.OrganizationType'
description: Type of organization.
members:
type: array
items:
$ref: '#/components/schemas/mix.api.OrganizationMember'
description: List of members in the organization.
isDeepLearningModelEnabled:
type: boolean
description: When set to true, DEEP_LEARNING model build is enabled.
isEnginePacksEnabled:
type: boolean
description: When set to true, engine pack selection is enabled.
isDataPacksEnabled:
type: boolean
description: When set to true, data pack selection is enabled.
description: Message that defines an organization.
grpc.gateway.runtime.Error:
type: object
properties:
error:
type: string
code:
type: integer
format: int32
message:
type: string
details:
type: array
items:
$ref: '#/components/schemas/google.protobuf.Any'
mix.api.OrganizationMember:
type: object
properties:
member:
$ref: '#/components/schemas/mix.api.User'
description: User that is a member of an organization.
roles:
type: array
items:
$ref: '#/components/schemas/mix.api.OrganizationRole'
description: List of roles assigned to this member.
description: Message that defines the roles assigned to a specific member.
mix.api.User:
type: object
properties:
id:
type: string
description: Unique ID identifiying the member in the organization.
email:
type: string
description: Email address of the user.
createTime:
type: string
format: date-time
description: Date and time the user was created.
lastLoginTime:
type: string
format: date-time
description: Date and time of the user's last login.
name:
type: string
description: Name of the user.
description: Message that defines a user that is a member of an organization.
mix.api.OrganizationType:
type: string
enum:
- TYPE_UNSPECIFIED
- PERSONAL
- STANDARD
default: TYPE_UNSPECIFIED
description: "Input field that specifies the type of organization.\n\n - TYPE_UNSPECIFIED: All types of organizations\n - PERSONAL: User's personal organization, identified with the user's email address\n - STANDARD: Global organization, such as a company, that typically includes many members"
securitySchemes:
OAuth2:
type: oauth2
flows:
clientCredentials:
scopes:
mix-api: Grants access to mix-api
tokenUrl: /oauth2/token
bearerAuth:
type: apiKey
name: Authorization
in: header