List API keys

GET/admin/projects/{project_id}/api-keysList API keys

List all API keys in a project.

Parameters

X-Pinecone-Api-Versionstringheaderrequired

Required date-based version header

default "2026-07"

project_idstring · uuidpathrequired

Project ID

Responses

objectListApiKeysResponse

dataarray of objectrequired

Show child attributes

Show array items

The details of an API key, without the secret.

idstring · uuidrequired

The unique ID of the API key.

namestringrequired

The name of the API key.

project_idstring · uuidrequired

The ID of the project containing the API key.

rolesarray of stringrequired

The roles assigned to the API key.

Show child attributes

Example response

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "project_id": "00000000-0000-0000-0000-000000000000",
      "roles": [
        "ProjectEditor"
      ]
    }
  ]
}

objectErrorResponse

The response shape used for all error responses.

errorobjectrequired

Detailed information about the error that occurred.

Show child attributes

codestringrequired

The error code. Possible values: `OK`, `UNKNOWN`, `INVALID_ARGUMENT`, `DEADLINE_EXCEEDED`, `QUOTA_EXCEEDED`, `NOT_FOUND`, `ALREADY_EXISTS`, `PERMISSION_DENIED`, `UNAUTHENTICATED`, `RESOURCE_EXHAUSTED`, `FAILED_PRECONDITION`, `ABORTED`, `OUT_OF_RANGE`, `UNIMPLEMENTED`, `INTERNAL`, `UNAVAILABLE`, `DATA_LOSS`, `FORBIDDEN`, or `UNPROCESSABLE_ENTITY`.

detailsobject

Additional information about the error. This field is not guaranteed to be present.

messagestringrequired

statusintegerrequired

The HTTP status code of the error.

Example response

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "Invalid API key."
  },
  "status": 401
}

objectErrorResponse

The response shape used for all error responses.

errorobjectrequired

Detailed information about the error that occurred.

Show child attributes

codestringrequired

detailsobject

Additional information about the error. This field is not guaranteed to be present.

messagestringrequired

statusintegerrequired

The HTTP status code of the error.

Example response

{
  "error": {
    "code": "QUOTA_EXCEEDED",
    "message": "The index exceeds the project quota of 5 pods by 2 pods. Upgrade your account or change the project settings to increase the quota."
  },
  "status": 429
}

objectErrorResponse

The response shape used for all error responses.

errorobjectrequired

Detailed information about the error that occurred.

Show child attributes

codestringrequired

detailsobject

Additional information about the error. This field is not guaranteed to be present.

messagestringrequired

statusintegerrequired

The HTTP status code of the error.

Example response

{
  "error": {
    "code": "UNKNOWN",
    "message": "Internal server error"
  },
  "status": 500
}

Examples

X-Pinecone-Api-Versionrequiredheader parameter

project_idrequiredpath parameter

curl -X GET 'https://api.pinecone.io/admin/projects/00000000-0000-0000-0000-000000000000/api-keys'

const response = await fetch('https://api.pinecone.io/admin/projects/00000000-0000-0000-0000-000000000000/api-keys', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.pinecone.io/admin/projects/00000000-0000-0000-0000-000000000000/api-keys', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.pinecone.io/admin/projects/00000000-0000-0000-0000-000000000000/api-keys")
print(response.json())

package main

import (
	"context"
	"net/http"
)

func main() {
	ctx := context.Background()
	req, err := http.NewRequestWithContext(ctx, "GET", "https://api.pinecone.io/admin/projects/00000000-0000-0000-0000-000000000000/api-keys", nil)
	if err != nil {
		panic(err)
	}
	resp, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer resp.Body.Close()
}

<?php
$request = curl_init("https://api.pinecone.io/admin/projects/00000000-0000-0000-0000-000000000000/api-keys");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.pinecone.io/admin/projects/00000000-0000-0000-0000-000000000000/api-keys"))
    .method("GET", HttpRequest.BodyPublishers.noBody())
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

require 'net/http'

uri = URI("https://api.pinecone.io/admin/projects/00000000-0000-0000-0000-000000000000/api-keys")
request = Net::HTTPGenericRequest.new("GET", false, true, uri)
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }

using var client = new HttpClient();
using var request = new HttpRequestMessage(HttpMethod.Get, "https://api.pinecone.io/admin/projects/00000000-0000-0000-0000-000000000000/api-keys");
using var response = await client.SendAsync(request);

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "string",
      "project_id": "00000000-0000-0000-0000-000000000000",
      "roles": [
        "ProjectEditor"
      ]
    }
  ]
}

{
  "error": {
    "code": "UNAUTHENTICATED",
    "message": "Invalid API key."
  },
  "status": 401
}

{
  "error": {
    "code": "QUOTA_EXCEEDED",
    "message": "The index exceeds the project quota of 5 pods by 2 pods. Upgrade your account or change the project settings to increase the quota."
  },
  "status": 429
}

{
  "error": {
    "code": "UNKNOWN",
    "message": "Internal server error"
  },
  "status": 500
}

Search documentation

API Keys

Organizations

Projects

Users

Invites

Service Accounts

Role Bindings

Parameters

Responses

API Keys

Organizations

Projects

Users

Invites

Service Accounts

Role Bindings