All Collections
API Keys — Previously: the REST API Connector
API Keys — Previously: the REST API Connector

How to connect your platform through APIs (backend) to

Updated over a week ago

Legacy statement

Customers before June 2023 had the option to connect their platform through a journy-proprietary REST API connector. This connector has meanwhile been replaced by a fixed settings page called "API access", due to the fact that the primary use is to query data out of

⚠️ If you still require back-end API connection to your platform, we highly recommend new customers to use our latest "SDK" connector, which is 100% compatible to Segment's SDKs. See


If you need access to the data objects in, you can create API keys in's settings. The API calls itself are described in the following doc: and we have SDKs available for Node.js, PHP, and Python.

Typical use cases are: a custom dashboard in your platform, showing Stages, Health, Scores, Segments and other computed properties from

How to create API Keys aka "Application"

Go to Settings → API access :

When pressing the [+] button, following screen will appear:

Here's what to fill in:

  • Name: The is the unique application name of API keys. This is mainly for UI and admin reasons throughout

  • This application is allowed to:

    • Read contacts: If set, you can collect all user and account information, including all properties and events, encountered from all connected apps.

    • Read events: If set, you can collect event information defined in

    • Read properties: If set, you can collect property information defined in

    • Read segments: If set, you can collect segment information defined in

    • Read campaigns (legacy): If set, you can collect campaign information defined in

    • Read channels (legacy): If set, you can collect channel information defined in

    • Retrieve tracking snippet for websites (legacy): This is the way to connect both UI-side/front-end (see and server-side/back-end integration. Only possible when the option is switched on.

    • Track events, create and update contacts (legacy): If set, you can create and update users and accounts, their relationship as well as trigger events on users, on accounts and on unique combination of both user and account.

Upon pressing 'Create Application', you'll receive your unique API key to be used with out SDKs. Learn how on:

Review API connector settings

When hoovering over the API Keys/Applications, you will see 3 icons: Logs, Edit and Delete. When pressing Edit, you'll see the following:

The 'Enable' switch allows you to turn on and off the API Key (without needing to delete or change API keys).

All other options are the same as when you connect, on top of being able to 'Regenerate' a new API key.

IMPORTANT: For extreme security reasons, there is no way to retrieve your API keys. You have to copy them somewhere safe when generated...or regenerate them.

Review API Key Logs

As previously mentioned, when hoovering over the API Keys/Applications, you will see 3 icons: Logs, Edit and Delete. When pressing Logs, you'll see detailed logs on anything that has been sync'ed between and your application.

Did this answer your question?