API Keys and How to Use Them

In this article we will explain API keys and how to use them with both API v2 and API v1.

Alex Conroy avatar
Written by Alex Conroy
Updated over a week ago

To use Telnyx v2 API endpoints, you will need an API Key and for our API v1 endpoints, you will need an API Token.

This article will explain how to get your API Key for API v2 or API Token for API v1.

Telnyx uses API Keys or Tokens to authenticate API requests from our customers.

Step by Step guide API v2 Key

Click Create API Key on the top right hand corner to create an API v2 Key.

This key is what you will use as the bearer token in your API requests.

A screenshot of the Create API Token button.
  • You will then be provided with your API v2 Key to copy.

  • If you lose it you can always go back to this section again to get it or create a new one.

  • You can also associate up to 10 tags per API Key.

Coming soon:

  • Adding search by tag functionality in the Mission Control Portal

  • Adding developer documentation to access managed your API Keys through an API endpoint.

Step by Step guide API v1 Token

A diagram of the API V1 Tokens button.
  • Click Create API Token.

A screenshot of the Create API Token button.
  • We will ask you to give it a name, you can name it whatever you want.

  • You will see a section on the right-hand side where you can click Copy Token.

  • If you lose it you can always go back to this section again to get it or create a new one.

A screenshot of the Copy Token button.

In your API request, please include two headers called:

  • x-api-user: <your account email>

  • x-api-token:<your account token> when making the API V1 request.

You can find more details on API v1 Tokens in our developer's docs here and our API v2 Key here

Did this answer your question?