Skip to main content

Get Started

Requirements​

The following is required to interact with the Incentify API:

  • An active Incentify Account, which includes API Access in its pricing plan
  • Active Incentify API Key

Getting an Incentify API Key​

1) Requesting an API Key

A user with the permission to "Manage API" in your Incentify account can email support@incentify.com to request an API Key. Incentify will follow up with a phone call to obtain verbal confirmation and then a final email notification will be sent to that user including the Super Admin on the account. Incentify will generate a SANDBOX API Key first (and follow up with a PRODUCTION API Key when ready).

Note: If the user has a parent/child account then confirmation of which account the API Key should be connected to will be confirmed.

2) Retrieving the API Key

A user with the permission to "Manage API" in your Incentify account can then login to the appropriate Incentify environment (SANDBOX / PRODUCTION) to get the API Key. Navigate to "settings" > "API Clients" > click to reveal the unmasked version of the API Key and copy it.

- Production = https://app.getincentify.com
- Sandbox (for developing/testing) = https://sandbox.getincentify.com

Using an Incentify API Key​

When making a request to an API Endpoint please include your API key within the x-api-key header. A cURL example can be found below:

curl --location --request GET 'https://api.incentify.com/rest/v1/projects?page=1' \
--header 'x-api-key: your_api_key_goes_here'

De-Activating an Incentify API Key​

If you ever need to de-activate an API Key, please follow the navigational steps mentioned above in "Retrieving the API Key" and instead of copying it you can click the button to revoke the API Key. This means the API Key is no longer valid and will not longer be able to make API requests. If you do this action in error, please contact Incentify to help resolve.

Next Steps​

You can either visit a Guide or go directly to the Project Resource (endpoint).