Skip to main content
GET
/
invites
/
{inviteId}
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/invites/123' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "invite": {
    "id": 123,
    "email": "john.doe@example.com",
    "createdAt": 1234567890,
    "inviteUrl": "http://YOURSITE.konstant.ly/signup/1qaz2wsx3edc4rfv"
}
}

Documentation Index

Fetch the complete documentation index at: https://docs.konstantly.com/llms.txt

Use this file to discover all available pages before exploring further.

Retrieve information about a specific invitation using its unique identifier.

​
Path Parameters

​
inviteId
integer
required
The unique identifier of the invitation to retrieve

​
Request Headers

​
X-API-KEY
string
required
API Key. Go to your Konstantly site > Settings > API and copy the value from there.

​
Response

​
invite
object
required
Invitation details

​
Error Responses

​
404
object
Returned when the invitation is not found
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/invites/123' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "invite": {
    "id": 123,
    "email": "john.doe@example.com",
    "createdAt": 1234567890,
    "inviteUrl": "http://YOURSITE.konstant.ly/signup/1qaz2wsx3edc4rfv"
}
}