Invite a user to the organization

Invite a user to the organization by email and grant their initial role bindings.

POST /admin/invites

curl

PINECONE_ACCESS_TOKEN="YOUR_ACCESS_TOKEN"

curl "https://api.pinecone.io/admin/invites" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "X-Pinecone-Api-Version: 2026-04" \
  -H "Authorization: Bearer $PINECONE_ACCESS_TOKEN" \
  -d '{
    "email": "[e-mail]",
    "role_bindings": [
      {
        "resource_type": "organization",
        "role": "OrgMember"
      },
      {
        "resource_type": "project",
        "resource_id": "a2f7dddb-1597-4eff-9f71-535fde243f58",
        "role": "ProjectMember"
      }
    ]
  }'

curl

{
  "id": "9c8e3528-b9c0-4358-84ce-84c28e91b566",
  "email": "[e-mail]",
  "status": "pending",
  "expires_at": "2026-05-21T03:00:00Z",
  "processed_at": null,
  "created_at": "2026-04-14T20:00:00Z"
}

curl

PINECONE_ACCESS_TOKEN="YOUR_ACCESS_TOKEN"

curl "https://api.pinecone.io/admin/invites" \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "X-Pinecone-Api-Version: 2026-04" \
  -H "Authorization: Bearer $PINECONE_ACCESS_TOKEN" \
  -d '{
    "email": "[e-mail]",
    "role_bindings": [
      {
        "resource_type": "organization",
        "role": "OrgMember"
      },
      {
        "resource_type": "project",
        "resource_id": "a2f7dddb-1597-4eff-9f71-535fde243f58",
        "role": "ProjectMember"
      }
    ]
  }'

curl

{
  "id": "9c8e3528-b9c0-4358-84ce-84c28e91b566",
  "email": "[e-mail]",
  "status": "pending",
  "expires_at": "2026-05-21T03:00:00Z",
  "processed_at": null,
  "created_at": "2026-04-14T20:00:00Z"
}

Authorizations

Authorization · string · header · required

An access token must be provided in the Authorization header using the Bearer scheme.

Headers

X-Pinecone-Api-Version · string · default: 2026-04 · required

Required date-based version header

Body

application/json

The invite to create.

email · string<email> · required

The email address to invite.

Maximum string length: 254

Example:

"[e-mail]"

role_bindings · object[] · required

Role bindings for the invitee. Must include at least one organization-scoped binding that grants organization membership (OrgOwner, OrgManager, OrgBillingAdmin, or OrgMember); project-scoped bindings are optional. Not returned in the response.

Required array length: 1 - 100 elements

Show child attributes

Response

200

application/json

Invite created and email sent. The invite's role bindings are first-class; view or change them through the role-binding endpoints.

An invitation to join the organization.

id · string<uuid> · required

The unique ID of the invite.

email · string<email> · required

The email address the invite was sent to.

status · string · required

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.

Example:

"pending"

created_at · string<date-time> · required

The date and time the invite was created.

expires_at · string<date-time> | null

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.

processed_at · string<date-time> | null

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