/admin/service-accounts/{service_account_id}Get service account detailsGet a service account by ID; the client secret is returned only from create and rotate-secret requests.
Parameters
X-Pinecone-Api-VersionstringheaderrequiredRequired date-based version header
service_account_idstring · uuidpathrequiredThe unique identifier of the service account.
Responses
A service account. The OAuth `client_secret` is not included.
client_idstringrequiredThe OAuth client ID used by the service account to obtain access tokens. Used only for OAuth token exchange.
created_atstring · date-timerequiredThe date and time the service account was created.
idstring · uuidrequiredThe unique identifier for the service account. Use this as the path parameter on `/admin/service-accounts/{service_account_id}` endpoints and as the `principal_id` when querying or creating role bindings.
namestringrequiredA short human-readable label, set by the caller at creation time.
updated_atstring · date-timerequiredThe date and time of the service account's most recent metadata update.
{
"client_id": "l3Ow0CmFyc4jOONcwiKUCRqQKN0tiCAn",
"created_at": "2026-04-10T15:23:00Z",
"id": "f8a3b2c1-4d5e-6f7a-8b9c-0d1e2f3a4b5c",
"name": "My Service Account",
"updated_at": "2026-04-12T09:11:00Z"
}The response shape used for all error responses.
errorobjectrequiredDetailed information about the error that occurred.
Show child attributes
codestringrequiredThe 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`.
detailsobjectAdditional information about the error. This field is not guaranteed to be present.
messagestringrequiredstatusintegerrequiredThe HTTP status code of the error.
{
"error": {
"code": "UNAUTHENTICATED",
"message": "Invalid API key."
},
"status": 401
}The response shape used for all error responses.
errorobjectrequiredDetailed information about the error that occurred.
Show child attributes
codestringrequiredThe 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`.
detailsobjectAdditional information about the error. This field is not guaranteed to be present.
messagestringrequiredstatusintegerrequiredThe HTTP status code of the error.
{
"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
}The response shape used for all error responses.
errorobjectrequiredDetailed information about the error that occurred.
Show child attributes
codestringrequiredThe 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`.
detailsobjectAdditional information about the error. This field is not guaranteed to be present.
messagestringrequiredstatusintegerrequiredThe HTTP status code of the error.
{
"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
}The response shape used for all error responses.
errorobjectrequiredDetailed information about the error that occurred.
Show child attributes
codestringrequiredThe 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`.
detailsobjectAdditional information about the error. This field is not guaranteed to be present.
messagestringrequiredstatusintegerrequiredThe HTTP status code of the error.
{
"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
}The response shape used for all error responses.
errorobjectrequiredDetailed information about the error that occurred.
Show child attributes
codestringrequiredThe 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`.
detailsobjectAdditional information about the error. This field is not guaranteed to be present.
messagestringrequiredstatusintegerrequiredThe HTTP status code of the error.
{
"error": {
"code": "UNKNOWN",
"message": "Internal server error"
},
"status": 500
}