Introduction
Agents
Knowledge Base
Organizations
Analytics
Preview & Voice Selection
Integrations
List Invitations
curl --request GET \
--url https://api.example.com/api/auth/organizations/invitations \
--header 'X-Organization-Id: <x-organization-id>'{
"invitations": [
{
"invite_id": "inv_xyz789",
"email": "newuser@example.com",
"client_id": "org_abc123",
"role": "user",
"invited_by": "user_def456",
"status": "pending",
"created_at": "2024-03-01T12:00:00Z",
"expires_at": "2024-03-08T12:00:00Z"
}
]
}
Organizations
List Invitations
GET
/
api
/
auth
/
organizations
/
invitations
List Invitations
curl --request GET \
--url https://api.example.com/api/auth/organizations/invitations \
--header 'X-Organization-Id: <x-organization-id>'{
"invitations": [
{
"invite_id": "inv_xyz789",
"email": "newuser@example.com",
"client_id": "org_abc123",
"role": "user",
"invited_by": "user_def456",
"status": "pending",
"created_at": "2024-03-01T12:00:00Z",
"expires_at": "2024-03-08T12:00:00Z"
}
]
}
Retrieve a list of all pending invitations for your organization.
Request
The unique identifier of the organization.
Response
List of invitation objects for the organization.
Show Invitation Object
Show Invitation Object
The unique identifier for the invitation.
The email address that the invitation was sent to.
The organization ID associated with the invitation.
The role assigned to the invitation.
The user ID of the person who created the invitation.
The status of the invitation (e.g.,
pending, accepted, cancelled).The timestamp when the invitation was created.
The timestamp when the invitation will expire.
{
"invitations": [
{
"invite_id": "inv_xyz789",
"email": "newuser@example.com",
"client_id": "org_abc123",
"role": "user",
"invited_by": "user_def456",
"status": "pending",
"created_at": "2024-03-01T12:00:00Z",
"expires_at": "2024-03-08T12:00:00Z"
}
]
}
⌘I