Skip to main content

​
Generating an API key

To use the NeetoEngage APIs, you must first generate an API key:
  1. Go to the Admin panel. Under General, click API keys.
  2. Click Add API key. The Add new API key pane opens.
  3. Enter a Name for the key.
  4. Pick an Expiry date, or check Never expires.
  5. Click Save changes.
  6. Copy the key from the API keys list using the copy icon. The key stays in the list, so you can copy it again later.

​
Making authenticated API requests

To authenticate your API requests, include a valid API key in the X-Api-Key header.

​
Header format

Include your API key in the X-Api-Key header of every request:
The API only returns JSON. If you send an Accept header, it must allow application/json. Otherwise you receive a 406 response.
Generate separate API keys for different workspaces. An API key generated in one workspace will not work in another.
API keys provide access to sensitive data. Treat them like passwords and follow security best practices.

​
Error responses

​
401 Unauthorized

If your API key is missing, invalid, or expired, you’ll receive a 401 error:

​
Common authentication issues

Problem: API key is missing or invalid.
Solution: Verify your API key is correct and hasn’t been revoked/expired.
Problem: Subdomain is left as the default value (spinkart) or incorrect.
Solution: Verify your subdomain name is properly added in the request URL. If no workspace exists for the subdomain, the API returns a 404 response.
Problem: The key was created in a different Neeto product.
Solution: Generate a new key in NeetoEngage.