API Keys

API Keys are usually provisioned by your internal IT support staff. They are necessary to interact with the AlumnIQ API. Each discrete application or user should have their own API key. A Key may be revoked without notice if we determine that it has been compromised or is otherwise being used in an abusive manner.

When making GET and DELETE requests to our REST API, you may simply include the api key as a query string parameter:

https://example.alumniq.com/api/v1/index.cfm/events/6001/attendees?apikey=abc123

For PUT and POST requests, include your API key as a body argument:

{
    "apikey": "abc123"
}