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
Authentication
Section titled “Authentication”Authorizationheader (required) (prefixed withToken) — UseAuthorization: Token <API_KEY>Example:Authorization: Token 12345abcdef
Request
Section titled “Request”Path parameters
Section titled “Path parameters”project_id(string, required) — The unique identifier of the project
Query parameters
Section titled “Query parameters”status(enum, optional) — Only return keys with a specific status- Allowed values:
active,expired
- Allowed values:
Response
Section titled “Response”A list of API keys
api_keys(list of ListProjectKeysV1ResponseApiKeysItems, optional)
Errors
Section titled “Errors”400 Bad Request Error
Section titled “400 Bad Request Error”Invalid Request
ErrorResponse
ListProjectKeysV1ResponseApiKeysItems
Section titled “ListProjectKeysV1ResponseApiKeysItems”member(ListProjectKeysV1ResponseApiKeysItemsMember, optional)api_key(ListProjectKeysV1ResponseApiKeysItemsApiKey, optional)
ErrorResponseLegacyError
Section titled “ErrorResponseLegacyError”err_code(string, optional) — The error codeerr_msg(string, optional) — The error messagerequest_id(string, optional) — The request ID
ErrorResponseModernError
Section titled “ErrorResponseModernError”category(string, optional) — The category of the errormessage(string, optional) — A message about the errordetails(string, optional) — A description of the errorrequest_id(string, optional) — The unique identifier of the request
ListProjectKeysV1ResponseApiKeysItemsMember
Section titled “ListProjectKeysV1ResponseApiKeysItemsMember”member_id(string, optional)email(string, optional)
ListProjectKeysV1ResponseApiKeysItemsApiKey
Section titled “ListProjectKeysV1ResponseApiKeysItemsApiKey”api_key_id(string, optional)comment(string, optional)scopes(list of string, optional)created(string, optional)
Examples
Section titled “Examples”Response
{
"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
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())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);
}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))
}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_bodyimport 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
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();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);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()