Skip to main content
Deepgram's Docs

Search documentation

Type to search this documentation.

On this pageOverview

List Project Keys

GET https://api.deepgram.com/v1/projects//keys

Retrieves all API keys associated with the specified project

Reference: https://developers.deepgram.com/reference/manage/keys/list

  • Authorization header (required) (prefixed with Token ) — Use Authorization: Token <API_KEY> Example: Authorization: Token 12345abcdef
  • project_id (string, required) — The unique identifier of the project
  • status (enum, optional) — Only return keys with a specific status
    • Allowed values: active, expired

A list of API keys

  • api_keys (list of ListProjectKeysV1ResponseApiKeysItems, optional)

Invalid Request

  • ErrorResponse
  • member (ListProjectKeysV1ResponseApiKeysItemsMember, optional)
  • api_key (ListProjectKeysV1ResponseApiKeysItemsApiKey, optional)
  • err_code (string, optional) — The error code
  • err_msg (string, optional) — The error message
  • request_id (string, optional) — The request ID
  • category (string, optional) — The category of the error
  • message (string, optional) — A message about the error
  • details (string, optional) — A description of the error
  • request_id (string, optional) — The unique identifier of the request
  • member_id (string, optional)
  • email (string, optional)
  • api_key_id (string, optional)
  • comment (string, optional)
  • scopes (list of string, optional)
  • created (string, optional)

Response

JSON
{
  "api_keys": [
    {
      "member": {
        "member_id": "1000-2000-3000-4000",
        "email": "john@test.com"
      },
      "api_key": {
        "api_key_id": "1234567890abcdef1234567890abcdef",
        "comment": "A comment",
        "scopes": [
          "admin"
        ],
        "created": "2021-01-01T00:00:00Z"
      }
    }
  ]
}

SDK Code

Python
import requests

url = "https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/keys"

headers = {"Authorization": "Token <apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
JavaScript
const url = 'https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/keys';
const options = {method: 'GET', headers: {Authorization: 'Token <apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
Go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/keys"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Token <apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
Ruby
require 'uri'
require 'net/http'

url = URI("https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/keys")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Token <apiKey>'

response = http.request(request)
puts response.read_body
Java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/keys")
  .header("Authorization", "Token <apiKey>")
  .asString();
PHP
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/keys', [
  'headers' => [
    'Authorization' => 'Token <apiKey>',
  ],
]);

echo $response->getBody();
C#
using RestSharp;

var client = new RestClient("https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/keys");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Token <apiKey>");
IRestResponse response = client.Execute(request);
Swift
import Foundation

let headers = ["Authorization": "Token <apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.deepgram.com/v1/projects/123456-7890-1234-5678-901234/keys")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu