This article explains the differences between API v1 and API v3 authentication in LiveAgent, how to obtain the correct API key for each version, and what to do if you encounter a 403 ApiKey not found error when using the API.
Understanding the Two API Versions
LiveAgent supports two API versions:
- API v1 – A legacy (deprecated) version. No new endpoints are being added, but it remains functional and can be used alongside API v3.
- API v3 – The current, actively developed version. New endpoints and enhancements are continuously added.
Both versions can be used simultaneously, but they require separate API keys. Using an API v3 key to authenticate against API v1 endpoints (or vice versa) will result in a 403 ApiKey not found error.
How to Obtain the Correct API Key
API v3 Key
- Log in to your LiveAgent account.
- Navigate to Configuration > System > API.
- Generate or manage your API v3 key here.
- Ensure the key has the appropriate permissions assigned for the operations you intend to perform (e.g., reading or posting messages).
API v1 Key
- Log in to your LiveAgent account.
- In the upper right corner of the API configuration page, switch to the Settings for API v1 section.
- Obtain your API v1 key from this section.
Troubleshooting: 403 "ApiKey not found" Error
If you receive a 403 ApiKey not found response when calling an API endpoint, the most common cause is using the wrong API key for the API version you are targeting. Follow these steps to resolve it:
- Confirm which API version the endpoint belongs to (v1 or v3).
- Make sure you are using the matching API key for that version.
- Verify that the API key has the required permissions for the specific operation (e.g., posting messages to a conversation).
API Permissions
When using API v3, permissions are managed per API key under Configuration > System > API. Ensure the key is granted the relevant scopes for the actions you want to perform, such as reading tickets or posting messages.
For API v1, authentication is handled via the v1-specific key obtained from the Settings for API v1 section. Make sure the agent account associated with the key has the appropriate role and access rights within LiveAgent.
Additional Notes
- API v1 is deprecated — it is recommended to migrate to API v3 for long-term compatibility and access to new features.
- Both API versions can be used simultaneously within the same LiveAgent instance.
- If you are unsure which API version an endpoint belongs to, consult the Swagger API descriptor available in LiveAgent's documentation.