> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pinecone.io/llms.txt
> Use this file to discover all available pages before exploring further.
# List users in the organization
> List users who are members of the caller's organization. Results are paginated.
Optional filters:
- `email` — case-insensitive match on the user's email address.
Pagination tokens apply to the full query, including `email`. See query parameters for cursor rules.
Role bindings are not included. Use `GET /admin/role-bindings` with `principal_type` and `principal_id` to list them.
```bash curl theme={null}
PINECONE_ACCESS_TOKEN="YOUR_ACCESS_TOKEN"
curl -X GET "https://api.pinecone.io/admin/users" \
-H "Authorization: Bearer $PINECONE_ACCESS_TOKEN" \
-H "accept: application/json" \
-H "X-Pinecone-Api-Version: 2026-04"
```
```json curl theme={null}
{
"data": [
{
"id": "e2e92523-85dc-4142-b8c2-e681be8b78df",
"email": "alice@example.com",
"name": "Alice Example",
"created_at": "2026-04-10T15:23:00Z",
"updated_at": "2026-04-12T09:11:00Z"
}
],
"pagination": {
"next": "eyJsYXN0X2lkIjoiZTJlOTI1MjMifQ=="
}
}
```
## OpenAPI
````yaml https://raw.githubusercontent.com/pinecone-io/pinecone-api/refs/heads/main/2026-04/admin_2026-04.oas.yaml get /admin/users
openapi: 3.0.3
info:
title: Pinecone Admin API
description: >
Provides an API for managing a Pinecone organization and its resources,
including projects, API keys, organization users and invites, service
accounts, and role bindings.
contact:
name: Pinecone Support
url: https://support.pinecone.io
email: support@pinecone.io
license:
name: Apache 2.0
url: https://www.apache.org/licenses/LICENSE-2.0
version: 2026-04
servers:
- url: https://api.pinecone.io
description: Production API endpoints
security:
- BearerAuth: []
tags:
- name: API Keys
description: Actions that manage API Keys.
- name: Organizations
description: Actions that manage organizations.
- name: Projects
description: Actions that manage projects.
- name: Users
description: Actions that manage users.
- name: Invites
description: Actions that manage invites.
- name: Service Accounts
description: Actions that manage service accounts.
- name: Role Bindings
description: Actions that manage role bindings.
paths:
/admin/users:
get:
tags:
- Users
summary: List users in the organization
description: >
List users who are members of the caller's organization. Results are
paginated.
Optional filters:
- `email` — case-insensitive match on the user's email address.
Pagination tokens apply to the full query, including `email`. See query
parameters for cursor rules.
Role bindings are not included. Use `GET /admin/role-bindings` with
`principal_type` and `principal_id` to list them.
operationId: list_users
parameters:
- in: header
name: X-Pinecone-Api-Version
description: Required date-based version header
required: true
schema:
default: 2026-04
type: string
style: simple
- in: query
name: email
description: >-
Case-insensitive filter on the user's email address. Malformed email
returns `400 INVALID_ARGUMENT`.
schema:
type: string
format: email
maxLength: 254
style: form
- in: query
name: limit
description: >-
The number of results to return per page. When omitted, the server
defaults to 100. Out-of-range values return `400 OUT_OF_RANGE`.
schema:
default: 100
type: integer
minimum: 1
maximum: 100
style: form
- in: query
name: paginationToken
description: >-
Cursor from `pagination.next` of a prior response. Must be reused
with the same query context (path parameters, filters, and `limit`).
schema:
type: string
style: form
responses:
'200':
description: A paginated list of users.
content:
application/json:
schema:
$ref: '#/components/schemas/UserList'
examples:
paginated-users:
summary: A page of users
value:
data:
- email: alice@example.com
id: e2e92523-85dc-4142-b8c2-e681be8b78df
name: Alice Example
pagination:
next: eyJsYXN0X2lkIjoiZTJlOTI1MjMifQ==
email-filter-match:
summary: Case-insensitive email filter, found
value:
data:
- email: alice@example.com
id: e2e92523-85dc-4142-b8c2-e681be8b78df
name: Alice Example
pagination: null
email-filter-empty:
summary: Case-insensitive email filter, no match
value:
data: []
pagination: null
'400':
description: Bad request. The request body included invalid request parameters.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
index-metric-validation-error:
summary: Validation error
value:
error:
code: INVALID_ARGUMENT
message: >-
Bad request. The request body included invalid request
parameters.
status: 400
'401':
description: 'Unauthorized. Possible causes: Invalid API key.'
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
unauthorized:
summary: Unauthorized
value:
error:
code: UNAUTHENTICATED
message: Invalid API key.
status: 401
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
examples:
internal-server-error:
summary: Internal server error
value:
error:
code: UNKNOWN
message: Internal server error
status: 500
4XX:
description: Unexpected error on request.
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
components:
schemas:
UserList:
example:
data:
- email: alice@example.com
id: e2e92523-85dc-4142-b8c2-e681be8b78df
name: Alice Example
pagination:
next: eyJsYXN0X2lkIjoiZTJlOTI1MjMifQ==
description: A paginated list of users in the organization.
type: object
properties:
data:
description: The page of users.
type: array
items:
$ref: '#/components/schemas/User'
pagination:
nullable: true
description: >-
Cursor envelope for the next page. `null` (or absent) on the final
page of results.
type: object
allOf:
- example:
next: eyJsYXN0X2lkIjogImluZGV4LTQifQ==
description: >-
Pagination metadata for list responses. When `next` is present,
pass it as `paginationToken` on the following request.
x-component-name: PaginationResponse
type: object
properties:
next:
example: eyJsYXN0X2lkIjogImluZGV4LTQifQ==
description: >-
Opaque cursor for the next page. Do not parse or construct.
Invalid or expired tokens return `400`.
type: string
required:
- data
ErrorResponse:
example:
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
description: The response shape used for all error responses.
type: object
properties:
status:
example: 500
description: The HTTP status code of the error.
type: integer
error:
example:
code: INVALID_ARGUMENT
message: >-
Index name must contain only lowercase alphanumeric characters or
hyphens, and must not begin or end with a hyphen.
description: Detailed information about the error that occurred.
type: object
properties:
code:
description: >-
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`.
x-enum:
- 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
- UNPROCESSABLE_ENTITY
type: string
message:
example: >-
Index name must contain only lowercase alphanumeric characters
or hyphens, and must not begin or end with a hyphen.
type: string
details:
description: >-
Additional information about the error. This field is not
guaranteed to be present.
type: object
required:
- code
- message
required:
- status
- error
User:
example:
email: alice@example.com
id: e2e92523-85dc-4142-b8c2-e681be8b78df
name: Alice Example
description: A user who is a member of the organization.
type: object
properties:
id:
description: The unique ID of the user.
type: string
format: uuid
email:
description: The user's email address.
type: string
format: email
name:
description: >-
The user's display name. Omitted from the response if the user has
not set one.
type: string
required:
- id
- email
securitySchemes:
BearerAuth:
type: http
scheme: bearer
description: >
An [access
token](https://docs.pinecone.io/guides/organizations/manage-service-accounts#retrieve-an-access-token)
must be provided in the `Authorization` header using the `Bearer`
scheme.
````