Skip to main content

​
Get Public Invitation

Get a public invitation by its ID. This endpoint does not require authentication and is used to display invitation details to potential users.

​
Path Parameters

​
id
string
required
The unique identifier of the invitation

​
Response

​
id
string
Invitation unique identifier
​
email
string
Email address the invitation was sent to
​
organization_id
string
ID of the organization for this invitation
​
project_id
string
ID of the project for this invitation (if applicable)
​
organization_role
string
Role in the organization (OWNER, ADMIN, MEMBER, VIEWER)
​
project_role
string
Role in the project (OWNER, ADMIN, MEMBER, VIEWER)
​
created_at
string
When the invitation was created (ISO 8601 format)
​
updated_at
string
When the invitation was last updated (ISO 8601 format)
​
organization
object
Organization details
​
project
object
Project details (if invitation is for a specific project)
curl --location --request GET 'https://api.plaisolutions.com/invitations/inv_123'

{
  "id": "inv_123",
  "email": "[email protected]",
  "organization_id": "org_456",
  "project_id": "proj_789",
  "organization_role": "MEMBER",
  "project_role": "MEMBER",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "organization": {
    "id": "org_456",
    "name": "Acme Corp",
    "address_line1": "123 Main St",
    "city": "San Francisco",
    "state": "CA",
    "zipcode": "94105",
    "country": "USA",
    "created_at": "2024-01-01T10:00:00Z",
    "updated_at": "2024-01-10T15:30:00Z"
  },
  "project": {
    "id": "proj_789",
    "name": "AI Assistant Project",
    "description": "Building an intelligent assistant",
    "organization_id": "org_456",
    "created_at": "2024-01-05T14:20:00Z",
    "updated_at": "2024-01-12T09:45:00Z"
  }
}

​
Use Cases

​
Invitation Flow

The invitation system follows this typical flow:
1

Send Invitation

An organization admin creates an invitation using the POST /organizations/{organization_id}/invitations endpoint
2

Share Invitation Link

The invitation link is shared with the recipient via email or other communication channels
3

View Invitation

The recipient uses this GET /invitations/{id} endpoint to view invitation details before accepting
4

Accept/Decline

The recipient uses the POST /me/invitations/{invitation_id}/reply endpoint to accept or decline

​
Security Considerations

This endpoint is public and does not require authentication. However, invitation IDs should be treated as sensitive and not shared publicly as they provide access to organization information.
Invitations have expiration periods and can be revoked by organization administrators at any time.

​
Error Responses

​
404
error
Invitation not found or has been revoked
​
410
error
Invitation has expired
{
  "error": "Invitation not found",
  "message": "The invitation with ID 'inv_123' does not exist or has been revoked."
}