Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-2685172326.0 KB
Invites

Invite a user to the organization

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

post/admin/invites

Headers

X-Pinecone-Api-Versionstring required

Required date-based version header

Request body

emailstring email required

The email address to invite.

Example request

{
  "email": "newhire@acme.com",
  "role_bindings": [
    {
      "resource_type": "project",
      "role": "ProjectOwner"
    }
  ]
}

Response

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

idstring uuid required

The unique ID of the invite.

emailstring email required

The email address the invite was sent to.

statusstring 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.

expires_atstring date-time nullable

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_atstring date-time nullable

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

created_atstring date-time required

The date and time the invite was created.

Example response

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