How to link a Public API Client to your TEQ instance
Before you start
Situation | What to do |
|---|---|
You have a reference code from the company that owns the API client | Follow the steps in this article. |
You do not have a reference code | Ask the owning company for it. You cannot link a client without one. |
You want to remove a client that is already linked | Go to Manage a linked client and use the unlink step. |
Link the client
- Click More in the sidebar if Settings is not visible, then click Settings and open Integration.
- Open the Integration tab, then select Custom Integration. Do not use Standard Integration for this task.
- Click Link Client. The Link Shared API Client window opens.
- Paste the reference code into the Reference Code field and click Verify.
- Check that the message Client found shows the correct client name. If the name is wrong, stop and confirm the code with the owning company.
- Select the scopes you want to grant to the client under Select Scopes.
- Keep Enabled selected if the client should be active after linking.
- Click Link Client. TEQ shows the message Client linked successfully, and the client appears in the Custom Integrations list.
⚠️ Warning: A client with no scopes selected has no access to your data. Select at least one scope, or assign scopes later from Manage.
Scopes
You can only grant scopes that the owning company exposes for this client. Scopes marked Not exposed by owner are disabled and cannot be selected.
⚠️ Warning: A client can only call endpoints covered by its granted scopes. A missing scope returns an error, not an empty result.
Check the linked client
The Custom Integrations list shows these columns for each linked client: Client Name, Client ID, Status, Mode, Scopes, Last Updated, and Actions. A client linked with specific scopes shows Scoped under Mode, and Scopes shows how many are granted.
Use Search by name or ID to find a client. Select Show enabled only to hide disabled clients.
Manage a linked client
- Open Settings, then Integration, then Custom Integration.
- To change scopes, click the gear icon in the Actions column of the client. Select or clear scopes, then click Save. Use the Enabled toggle in the top right to switch the client on or off.
- To see the client’s requests, click the history icon in the Actions column. The Activity Log window lists the Timestamp, Method, Endpoint, and Status of each call.
- To unlink the client, click the red bin icon in the Actions column. The bin unlinks the client from your company. It does not delete the client for the owning company.
❌ Do not click the red bin icon to disable a client temporarily. Unlinking removes the client from your list and ends its access. Use the Enabled toggle instead.
Troubleshooting
🔍 Check this first: If a call returns status 403 in the Activity Log window, the client does not have the scope for that endpoint.
- Verify does not find the client: check the reference code for typos or extra spaces, then confirm the code with the owning company.
- A scope is greyed out: the owning company has not exposed it. Ask them to expose it, then reopen the client.
- The client cannot call TEQ after linking: check that Status shows Enabled and that at least one scope is granted.
- The client is missing from the Custom Integrations list: it may have been unlinked. Link it again with the reference code.
- You cannot find Link Client: confirm you are on the Custom Integration tab, not Standard Integration.
Still having trouble?
Contact TEQ Support with the Client ID, the reference code, and a screenshot of the Activity Log window for faster assistance.