Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

List invites

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

JavaScript
// Requires Node.js SDK v8.2.0 or later
import { AdminClient } from '@pinecone-database/pinecone';

// Reads PINECONE_CLIENT_ID and PINECONE_CLIENT_SECRET from the environment
const admin = new AdminClient();

const { data: invites } = await admin.invites.list();
console.log(invites);
Go
// Requires Go SDK v6.0.0 or later
package main

import (
    "context"
    "fmt"
    "log"
    "os"

    "github.com/pinecone-io/go-pinecone/v6/pinecone"
)

func main() {
    ctx := context.Background()

    adminClient, err := pinecone.NewAdminClientWithContext(ctx, pinecone.NewAdminClientParams{
        ClientId:     os.Getenv("PINECONE_CLIENT_ID"),
        ClientSecret: os.Getenv("PINECONE_CLIENT_SECRET"),
    })
    if err != nil {
        log.Fatalf("Failed to create AdminClient: %v", err)
    }

    invites, err := adminClient.Invite.List(ctx, &pinecone.ListInvitesParams{})
    if err != nil {
        log.Fatalf("Failed to list invites: %v", err)
    }
    for _, invite := range invites.Data {
        fmt.Printf("Invite: %v (status: %v)\n", invite.Email, invite.Status)
    }
}
Terraform
# Requires Terraform provider v4.0.0 or later
data "pinecone_invites" "all" {}

output "invite_emails" {
  value = [for invite in data.pinecone_invites.all.invites : invite.email]
}
curl
PINECONE_ACCESS_TOKEN="YOUR_ACCESS_TOKEN"

curl -X GET "https://api.pinecone.io/admin/invites" \
	-H "Authorization: Bearer $PINECONE_ACCESS_TOKEN" \
	-H "accept: application/json" \
	-H "X-Pinecone-Api-Version: 2026-04"
curl
{
  "data": [
    {
      "id": "9c8e3528-b9c0-4358-84ce-84c28e91b566",
      "email": "newhire@example.com",
      "status": "pending",
      "expires_at": "2026-05-21T03:00:00Z",
      "processed_at": null,
      "created_at": "2026-04-14T20:00:00Z"
    }
  ],
  "pagination": {
    "next": "eyJsYXN0X2lkIjoiOWM4ZTM1MjgifQ=="
  }
}
GET/admin/invites

List invites

3 parameters
  • X-Pinecone-Api-Versionstringheaderrequired

    Required date-based version header

  • 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`.

  • paginationTokenstringquery

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

Suggest an edit

Propose a replacement for this page. The site team reviews it before applying any changes.

Export
Documentation menu