Skip to main content
Pinecone Docs

Search documentation

Type to search this documentation.

Get invite details

Get an invite in the caller's organization by ID.

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 invite = await admin.invites.describe('YOUR_INVITE_ID');
console.log(invite);
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)
    }

    invite, err := adminClient.Invite.Describe(ctx, "YOUR_INVITE_ID")
    if err != nil {
        log.Fatalf("Failed to describe invite: %v", err)
    }
    fmt.Printf("Invite: %v (status: %v)\n", invite.Email, invite.Status)
}
Terraform
# Requires Terraform provider v4.0.0 or later
data "pinecone_invite" "example" {
  id = "YOUR_INVITE_ID"
}

output "invite_status" {
  value = data.pinecone_invite.example.status
}
curl
PINECONE_ACCESS_TOKEN="YOUR_ACCESS_TOKEN"
PINECONE_INVITE_ID="9c8e3528-b9c0-4358-84ce-84c28e91b566"

curl -X GET "https://api.pinecone.io/admin/invites/$PINECONE_INVITE_ID" \
	-H "Authorization: Bearer $PINECONE_ACCESS_TOKEN" \
	-H "accept: application/json" \
	-H "X-Pinecone-Api-Version: 2026-04"
curl
{
  "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"
}
GET/admin/invites/{invite_id}

Get invite details

2 parameters
  • X-Pinecone-Api-Versionstringheaderrequired

    Required date-based version header

  • invite_idstringpathrequired

    Invite ID

Suggest an edit

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

Export
Documentation menu