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

{
    "invites": [
{
    "id": 1,
    "email": "john.doe@example.com",
    "createdAt": 1234567890,
    "inviteUrl": "http://YOURSITE.konstant.ly/signup/1qaz2wsx3edc4rfv"
},
{
    "id": 2,
    "email": "jane.smith@example.com",
    "createdAt": 1234567891,
    "inviteUrl": "http://YOURSITE.konstant.ly/signup/2wsx3edc4rfv5tgb"
}
    ]
}
Retrieve a list of all email invitations that have been processed on your platform.

​
Request Headers

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

​
Response

​
invites
array
required
List of invitation objects
curl --request GET \
--url 'https://YOURSITE.konstant.ly/openapi/v1/invites' \
--header 'X-API-KEY: 1qaz2wsx3edc4rfv1qaz2wsx3edc4rfv'

{
    "invites": [
{
    "id": 1,
    "email": "john.doe@example.com",
    "createdAt": 1234567890,
    "inviteUrl": "http://YOURSITE.konstant.ly/signup/1qaz2wsx3edc4rfv"
},
{
    "id": 2,
    "email": "jane.smith@example.com",
    "createdAt": 1234567891,
    "inviteUrl": "http://YOURSITE.konstant.ly/signup/2wsx3edc4rfv5tgb"
}
    ]
}