curl --request POST \
--url https://api.pinecone.io/admin/invites \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Pinecone-Api-Version: <x-pinecone-api-version>' \
--data '
{
"email": "newhire@acme.com",
"role_bindings": [
{
"resource_type": "organization",
"role": "OrgMember"
}
]
}
'{
"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"
}Invite a user to the organization
Invite a user to the organization by email and grant their initial role bindings.
curl --request POST \
--url https://api.pinecone.io/admin/invites \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'X-Pinecone-Api-Version: <x-pinecone-api-version>' \
--data '
{
"email": "newhire@acme.com",
"role_bindings": [
{
"resource_type": "organization",
"role": "OrgMember"
}
]
}
'{
"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"
}Authorizations
An access token must be provided in the Authorization header using the Bearer scheme.
Headers
Required date-based version header
Body
The invite to create.
The email address to invite.
254"newhire@acme.com"
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.
1 - 100 elementsShow child attributes
Show child attributes
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.
The unique ID of the invite.
The email address the invite was sent to.
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.
"pending"
The date and time the invite was created.
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.
The date and time the invite was accepted. null or omitted while the invite is still pending or expired.
Was this page helpful?