Skip to main content
Please execute the following steps to provision a dedicated API key for our analytics integration.

​
Important Note

Lattice does not have a “Scope Selection” screen (checkboxes) when you generate an API Key. Instead, the API Key inherits the exact permissions of the user who generates it. If you use your own “Super Admin” account to generate the key, that key can see everything (Social Security Numbers, Salary, Feedback). To follow the principle of least privilege (and to ensure the integration doesn’t break if you leave the company), you should create a Service Account specifically for the integration that has exactly and only the permissions you want to grant via API.

​
Phase 1: Create a Service User (Crucial Step)

Since Lattice API keys inherit the permissions of the creating user, we must create a “virtual” user first to act as the service account. Do not skip this, or the API key will be tied to a specific human employee.

​
Create a New User

  • Task: Admin → People → Directory → Add Employees
  • Name: Integration Service User (or Profile Bot)
  • Email: security+lattice@[yourcompany].com (Use a shared alias).
  • Role: Standard Employee (initially).

​
Grant Permissions (The “Scopes”)

  • Task: Admin → People → Permissions → Custom Roles
  • Action: Create a new Custom Role named “Analytics API Access”.
  • Assignments: Assign this role only to the new Service User created in Step 1.
  • Capabilities: Check the following permissions for this role (equivalent to API Scopes):

​
Phase 2: Generate the API Key

​
Log In as the Service User

You must log out of your personal admin account and log in as the new “Integration Service User” created in Phase 1 to ensure the key is tied to that user’s specific permissions.

​
Generate Key

  • Navigate: Admin → Settings (bottom left) → Platform → API Keys.
  • Action: Click “Generate API Key”.
  • Name: Human Intelligence Analytics Integration

​
Phase 3: Handover

Please securely transmit the following values.
The API Key is only visible once.
  1. API Key
  2. Base URL (Confirm this matches your tenant URL, e.g: https://api.latticehq.com/v1)