Search

Locating API keys, list IDs and form IDs

Note: This SOAP API will be decommissioned on October 30, 2025. Active development of this API version has been discontinued since 2017. If your application still uses SOAP, please contact the developer to update to the modern REST API.
The REST API offers improved performance, better documentation, and new features.

If you want to connect CleverReach to an external system, you will generally need the following information:

In this article, you’ll learn how to find this information in your CleverReach account :

Find your API key

  1. Log in to your CleverReach account and click on the profile icon in the upper right corner > My Account > Interfaces > REST API.
  2. Click Create OAuth2 App  (if one does not yet exist).
  3. Enter a name and, if applicable, a redirect URL, then click Create Now.
  4. Your OAuth2 app has been created. Click the three dots ••• on the right > Edit. 
  5. Under the OAuth2 App Data tab, make a note of the Client ID and the Client Secret associated with the app.
  6. Create a callback page that will be called once the OAuth process is complete.
    Upload this file to a server that it references as the redirect_uri.
    Redirect the user to our OAuth service (see sample code)
    The user grants you access by logging in to CleverReach®.
    Once the OAuth process is complete, the redirect_uri is called.
    The redirect_uri—your callback page—is called with a code.
    Immediately exchange this code for an access token (see sample code).
    Please note that the code is only valid for a few seconds!
    This way, all your users can provide you with a token via an OAuth app .
    It’s really easy. Give it a try!

Find the list ID (group ID)

  1. Log in to your CleverReach account and click on Recipients in the menu.
  2. Open the list for which you need the ID.
  3. You’ll find the ID at the very end of the URL:

Find the form ID

  1. Log in to your CleverReach account and click on Forms in the menu.
  2. Click on the three dots to the right of the corresponding form ••• > Settings.
  3. Here you will find the form ID:

Help & Support

If you have any questions or need help, feel free to contact our service team at any time.