The Eventsforce API allows external applications to query and manipulate data stored in Eventsforce. For this to work, you must create an API role and provide an API key. The API key is a secret password allowing users to access your Eventsforce account's data.

You can read our API documentation for developers to understand what is included in the API.

This article covers the following:

The first step is to create an API role that will then be assigned to a standalone user. Follow the steps below:

We recommend starting with the minimum access required, which usually includes the 'read' functions. Read functions ensure your organization’s Eventsforce data can be accessed but not modified. The following are read-only functions:

If you use the API with many events, ensure the user can access the events from which they will pull data.

If you require your applications to update Eventsforce, for example, if you use attendance recording through Eventsforce Attendance, you will also need to add the following functions:

The next step is to assign the API role to a standalone user. If the user does not exist, add a new user before going forward. Once created, complete the steps below:

Note: The API role should not be assigned to other active users with different roles. The API is a standalone role.

The final step is to generate an API key. This is a secret password that the API will use to access data in your events. To create the key:

A new key will be generated that looks something like this:

C82749F75A044C5A9A6B6BF125B1F479

This key should be kept confidential and treated like a password.

You must add the API key to the other application you are working with, such as Eventsforce Attendance.