Skip to main content
POST

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

"newhire@acme.com"

​
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

Response

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.