Welcome to Inkle

Authentication

Follow these steps to generate and use your API token to authenticate requests with the platform.

Step 1 — Log in to Inkle

Go to app.inkle.io and sign in to your account.

Step 2 — Open API Settings

In the left sidebar, navigate to Settings → API Settings (or go directly to app.inkle.io/settings/api-settings).

Step 3 — Generate a Token

Click Generate API Token. Copy the token immediately—it will not be shown again. Store it securely like a password.

⚠️ Note on Token Expiration: Tokens expire after 30 days. When your token expires, revisit API Settings and click Regenerate.

Step 4 — Authenticate Your Requests

Pass the token as a Bearer token in your Authorization header:

Authorization: Bearer inka_xxxxxxxxxxxxxxxxxxxx

Step 5 — Get your Group ID and Entity ID

Most API endpoints require a group_id and entity_id. Fetch them by running the following command:

curl https://app.inkle.io/api/inkle/company/group/entities/ \
  -H "Authorization: Bearer inka_xxxxxxxxxxxxxxxxxxxx"

Example Response:

{
  "groups": [
    {
      "uuid": "your-group-id",
      "name": "Acme Inc.",
      "entities": [
        {
          "uuid": "your-entity-id",
          "name": "Acme Inc. Delaware",
          "country": "United States",
          "formation_type": "C Corporation"
        }
      ]
    }
  ]
}

Use groups[0].uuid as your group_id and groups[0].entities[0].uuid as your entity_id in all subsequent API calls.