Authentication for accessing our APIs is required via an API key. Users must include this key in the header of their API requests, specifically in the X-API-KEY field.

NOTE: This option is for the curl command - a full curl command will follow a bit later).

E.g.: --header 'X-API-KEY: uk_xxxxxx'

Each API key begins with the prefix uk_, representing 'user key'. These keys are user-specific and grant associated user privileges.

It is imperative to keep these keys secure, as they carry permissions tied to the user's account. Exercise caution when regenerating the key, as it may disrupt your current integrations with Smartreach.

API calls without the API key will fail.

To create or manage an API key, go to Settings -> Team Settings -> Integrations, under the API Key section.


Reference video: Authentication