evenito API documentation (1.0.0)

By using the API key, API requests can be done by simply having the key in the Authorization header.

Note: To be efficient, many endpoints should be used with the correct query parameters. For inspiration, follow samples of how our application (app.evenito.com) does API calls or request for a more personalized documentation from evenito.

Pagination

All get many endpoints are paginated to return maximum 300 entities in a single call.

Required headers

Authorization: Bearer {token / API key}
evenito-space-id: {spaceId}

Api keys are meant to improve the ease of API access and the maintenance and rotation of API access keys. API tokens do not expire, therefore the rotation can be determined by the users themselves.

Retrieve a normal user key

The bearer token from your user can be retrieved by taking a look into the network tab when logged in as a space_administrator in the space that you want to create an api key for.

This token has a very limited lifetime so if it runs out by the time you have prepared the API call to create your API then grab a new one from the browser. As the next step do a POST call to the API keys endpoint with this token in order to add a permanent API key.

Get all future unarchived events and save them.

For the full list of available filters, see the Search Reference. Request:

curl 'https://api.app.evenito.com/spaces/{space_id}/events?page=1&limit=10&sort=start_timestamp%2CASC&sort=calculated_end_timestamp%2CASC&s={"$and":[{"parent_id":{"$isnull":true}},{"status":{"$ne":"archived"}},{"calculated_end_timestamp":{"$gt":"now()"}}]}' \
  -H 'authorization: Bearer ey...' \
  -H 'evenito-space-id: {space_id}' \

Note that without {"parent_id":{"$isnull":true}} also schedules from within events are returned.

Response:

{
    "error": false,
    "data": [
        {events listed here},
        ],
    "count": 4,
    "total": 4,
    "page": 1,
    "pageCount": 1
}

Bulk uploading contacts into events

Request:

curl 'https://api.app.evenito.com/events/{eventId}/contacts/bulk' \
  -H 'accept: application/json, text/plain, */*' \
  -H 'accept-version: 2' \
  -H 'authorization: Bearer ey...' \
  -H 'content-type: application/json' \
  -H 'evenito-space-id: {space_id}' \
  --data-raw '{"bulk":
                [
                    {"language":"de","data":{"firstName":"test1","lastName":"test1","email":"test1@test.com"}},
                    {"language":"en","data":{"firstName":"test2","lastName":"test2","email":"test2@test.com"}}
                ]
            }'

The response will include all uploaded contacts.\

Getting emails that are in the block-list

Request:

curl 'https://api.app.evenito.com/emails/unsubscribe?page=1&limit=20' \
  -H 'authorization: Bearer ey...' \
  -H 'evenito-space-id: {space_id}'

Response:

{
    "error": false,
    "data": [
        {emails listed here}
    ],
    "count": 4,
    "total": 4,
    "page": 1,
    "pageCount": 1
}