List workspaces
List the workspaces in the project. Results are paginated; the pagination object is omitted when there are no further results.
GET /workspaces
curl --request GET \
--url https://api.pinecone.io/workspaces \
--header 'Api-Key: <api-key>' \
--header 'X-Pinecone-Api-Version: <x-pinecone-api-version>'import requests
url = "https://api.pinecone.io/workspaces"
headers = {
"Api-Key": "<api-key>",
"X-Pinecone-Api-Version": "<x-pinecone-api-version>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: "GET", headers: {"Api-Key": "<api-key>", "X-Pinecone-Api-Version": "<x-pinecone-api-version>"}};
fetch("https://api.pinecone.io/workspaces", options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.pinecone.io/workspaces",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Api-Key: <api-key>",
"X-Pinecone-Api-Version: <x-pinecone-api-version>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.pinecone.io/workspaces"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Api-Key", "<api-key>")
req.Header.Add("X-Pinecone-Api-Version", "<x-pinecone-api-version>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.pinecone.io/workspaces")
.header("Api-Key", "<api-key>")
.header("X-Pinecone-Api-Version", "<x-pinecone-api-version>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.pinecone.io/workspaces")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Api-Key"] = '<api-key>'
request["X-Pinecone-Api-Version"] = '<x-pinecone-api-version>'
response = http.request(request)
puts response.read_body{
"pagination": {
"next": "dXNlcl9pZD11c2VyXzE="
},
"workspaces": [
{
"created_at": "2026-06-01T00:00:00.000Z",
"host": "production-c01b5b5.wksp.aws-us-east-1-b921.byoc.pinecone.io",
"name": "production",
"spec": {
"byoc": {
"environment": "aws-us-east-1-b921.byoc"
}
},
"status": {
"ready": true,
"state": "Ready"
},
"updated_at": "2026-06-11T13:00:00.000Z"
},
{
"created_at": "2026-06-10T00:00:00.000Z",
"host": "staging-7a1f9c1.wksp.aws-us-east-1-b921.byoc.pinecone.io",
"name": "staging",
"spec": {
"byoc": {
"environment": "aws-us-east-1-b921.byoc"
}
},
"status": {
"ready": true,
"state": "Ready"
},
"updated_at": "2026-06-11T13:00:00.000Z"
}
]
}{
"error": {
"code": "UNAUTHENTICATED",
"message": "Invalid API key."
},
"status": 401
}{
"error": {
"code": "UNKNOWN",
"message": "Internal server error"
},
"status": 500
}Authorizations
Section titled “Authorizations”Api-KeystringrequiredAn API Key is required to call Pinecone APIs. Get yours from the console.
Headers
Section titled “Headers”X-Pinecone-Api-VersionstringrequiredRequired date-based version header
Query Parameters
Section titled “Query Parameters”limit?integerThe number of results to return per page.
Required range: 1 <= x <= 100
paginationToken?stringThe token to use to retrieve the next page of results.
Response
Section titled “Response”200 — This operation returns a list of all the workspaces that you have previously created, and which are associated with the given project.
The list of workspaces that exist in the project.
workspacesobject[]requiredList of workspaces in the project
Show child attributes
namestringrequiredThe name of the workspace. Resource name must be 1-45 characters long, start and end with an alphanumeric character, and consist only of lower case alphanumeric characters or '-'.
Required string length: 1 - 45. Example: example-workspace
specobjectrequiredThe spec object defines the environment in which the workspace's contexts are created. Workspaces are created in a customer-managed BYOC (Bring Your Own Cloud) environment.
Show child attributes
byocobjectrequiredConfiguration needed to create a workspace in a BYOC (Bring Your Own Cloud) environment.
Show child attributes
environmentstringrequiredThe BYOC environment where the workspace's contexts are hosted.
Example: aws-us-east-1-b921.byoc
hoststringrequiredThe URL address where the workspace is hosted.
Example: production-c01b5b5.wksp.prod.pinecone.io
created_atstringrequiredThe date and time the workspace was created.
Example: 2026-06-21T00:00:00.000Z
updated_atstringrequiredThe date and time the workspace was last updated.
Example: 2026-06-21T00:00:00.000Z
statusobjectrequiredThe current status of the workspace.
Show child attributes
readybooleanrequiredWhether the workspace is ready for use.
statestringrequiredThe state of the workspace. Possible values: Initializing, InitializationFailed, Ready, or Terminating.
pagination?objectPagination information. Present only when more results are available; absent on the final page.
Show child attributes
nextstringrequiredThe token to use to retrieve the next page of results.
Example: dXNlcl9pZD11c2VyXzE=