List invites

GET/admin/invitesList invites

List pending and expired invites in the caller's organization.

Parameters

X-Pinecone-Api-Versionstringheaderrequired

Required date-based version header

default "2026-07"

limitintegerquery

The number of results to return per page. When omitted, the server defaults to 100. Out-of-range values return `400 OUT_OF_RANGE`.

default 100 · maximum 100 · minimum 1

paginationTokenstringquery

Cursor from `pagination.next` of a prior response. Must be reused with the same query context (path parameters, filters, and `limit`).

Responses

objectInviteList

A paginated list of invites in the organization.

dataarray of objectrequired

The page of invites.

Show child attributes

Show array items

An invitation to join the organization.

created_atstring · date-timerequired

The date and time the invite was created.

emailstring · emailrequired

The email address the invite was sent to.

expires_atnull | string · date-time

When the invite expires if not accepted. Default TTL is 7 days. Resending the invite extends this to now plus 7 days. `null` if the invite does not expire.

idstring · uuidrequired

The unique ID of the invite.

processed_atnull | string · date-time

The date and time the invite was accepted. `null` or omitted while the invite is still pending or expired.

statusstringrequired

The lifecycle status of an invite. Possible values: `pending`, `expired`, `processed`. List endpoints return only `pending` and `expired` invites; `processed` is returned only when fetching a single invite by ID.

paginationvalue

Show child attributes

anyOf · 2 options

Option 1object

Cursor envelope for the next page. `null` (or absent) on the final page of results.

allOf · 1 option

Option 1object

Pagination metadata for list responses. When `next` is present, pass it as `paginationToken` on the following request.

nextstring

Opaque cursor for the next page. Do not parse or construct. Invalid or expired tokens return `400`.

Option 2nullnullable

Example response

{
  "data": [
    {
      "created_at": "2026-04-14T20:00:00Z",
      "email": "newhire@acme.com",
      "expires_at": "2026-05-21T03:00:00Z",
      "id": "9c8e3528-b9c0-4358-84ce-84c28e91b566",
      "processed_at": null,
      "status": "pending"
    }
  ],
  "pagination": {
    "next": "eyJsYXN0X2lkIjoiOWM4ZTM1MjgifQ=="
  }
}

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": "INVALID_ARGUMENT",
    "message": "Bad request. The request body included invalid request parameters."
  },
  "status": 400
}

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": "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": "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

limitquery parameter

paginationTokenquery parameter

curl -X GET 'https://api.pinecone.io/admin/invites?limit=100&paginationToken=string'

const response = await fetch('https://api.pinecone.io/admin/invites?limit=100&paginationToken=string', { method: 'GET' });
const data = await response.json();

const response = await fetch('https://api.pinecone.io/admin/invites?limit=100&paginationToken=string', { method: 'GET' });
console.log(await response.json());

import requests

response = requests.request("GET", "https://api.pinecone.io/admin/invites?limit=100&paginationToken=string")
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/invites?limit=100&paginationToken=string", 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/invites?limit=100&paginationToken=string");
curl_setopt($request, CURLOPT_CUSTOMREQUEST, "GET");
$response = curl_exec($request);
curl_close($request);

var request = HttpRequest.newBuilder(URI.create("https://api.pinecone.io/admin/invites?limit=100&paginationToken=string"))
    .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/invites?limit=100&paginationToken=string")
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/invites?limit=100&paginationToken=string");
using var response = await client.SendAsync(request);

{
  "data": [
    {
      "created_at": "2026-04-14T20:00:00Z",
      "email": "newhire@acme.com",
      "expires_at": "2026-05-21T03:00:00Z",
      "id": "9c8e3528-b9c0-4358-84ce-84c28e91b566",
      "processed_at": null,
      "status": "pending"
    }
  ],
  "pagination": {
    "next": "eyJsYXN0X2lkIjoiOWM4ZTM1MjgifQ=="
  }
}

{
  "error": {
    "code": "INVALID_ARGUMENT",
    "message": "Bad request. The request body included invalid request parameters."
  },
  "status": 400
}

{
  "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": "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