Sign in

v77

latestOpenAPI 3.1.0MITraw.githubusercontent.com2026-08-012528701.8 MB
Project Tokens

Create API token

Generate an API Token for a project to be used to authenticate requests within the project.

Permissions

The API token used to authenticate must have the following scope(s) enabled to make a successful request: Management.

Learn more about API scopes.

Token Permissions

You must set the functions allowed by this API Token by selecting which types of requests this API Token is allowed to make.

Valid options are: calling, chat, datasphere, fax, management, messaging, numbers, pubsub, storage, tasking, and video

post/api/project/tokens

Request body

namestring required

The name representing the API token.

permissionsProjectTokenPermission[] required

The permissions you would like to enable for this token. Valid permissions are calling, chat, datasphere, fax, management, messaging, numbers, pubsub, storage, tasking, and video

subproject_idstring uuid

Universal Unique Identifier.

Example request

{
  "name": "John Doe's Token",
  "permissions": [
    "calling",
    "fax",
    "messaging"
  ]
}

Response

The request has succeeded.

idstring uuid required

Universal Unique Identifier.

namestring required

The name of the created API Token.

permissionsProjectTokenPermission[] required

The permissions enabled for this token.

tokenstring required

The API token that can be used along with the project ID for basic authentication

Example response

{
  "name": "John Doe's Token",
  "permissions": [
    "calling",
    "fax",
    "messaging"
  ],
  "token": "PT037258e533e87ac63174ee136ed0798dc85d4f4f9e6d7191"
}