Skip to main content
Admin privileges are required to create API keys in Kustomer.

Generate an API Key

Create an API key to authenticate with the Kustomer API.

1

Navigate to API Key Settings

Sign in to your Kustomer instance at https://<your-org>.kustomerapp.com.

  • Navigate to Settings > Security > API Keys.
  • Click Add API Key.
2

Configure Roles

Select the roles (permissions) needed for your integration.

  • For read access: assign org.permission.customer.read, org.permission.conversation.read, org.permission.message.read, org.permission.user.read.
  • For full access: assign org.user.* or org.admin.*.
  • Roles cannot be changed after creation — the key must be deleted and recreated with new roles.
3

Copy the API Key

After creation, copy the API key immediately. It is only shown once and cannot be retrieved again. Store it securely.

Find Your Organization Name

Your Kustomer organization name is needed for the API base URL.

1

Locate from your browser URL

After logging in to Kustomer, look at the URL in your browser address bar. It follows the format https://<org-name>.kustomerapp.com.

  • Organization Name is the subdomain before .kustomerapp.com (e.g., mycompany).
1

Connect

  • Click Connect.
  • If applicable, the provider will redirect you to a sign-in or authorization page. Complete the provider’s authorization flow.
  • Once authorization is successful, you will see a confirmation popup.
2

Use Actions

Connect an AI platform to the linked account’s actions. See AI Platforms.Other ways to call actions are listed in Protocols & SDKs.