DocsError CodesPUBLIC_API_KEY_SCOPE_NOT_ALLOWED
Public APIHTTP 403

PUBLIC_API_KEY_SCOPE_NOT_ALLOWED

API key does not have the required scope for this endpoint.

The API key is valid but has scope restrictions that do not include access to this endpoint. Each API key can be limited to specific scopes (e.g. "carddav", "feed.product"). If the key has any scopes assigned, only those endpoints are accessible.

Example Error Response

JSON format

{
"error": {
"code": "PUBLIC_API_KEY_SCOPE_NOT_ALLOWED",
"message": "API key does not have the required scope for this endpoint.",
"description": "The API key is valid but has scope restrictions that do not include access to this endpoint. Each API key can be limited to specific scopes (e.g. \"carddav\", \"feed.product\"). If the key has any scopes assigned, only those endpoints are accessible."
}
}

Troubleshooting Steps

Follow these steps to resolve this error

1

Check the scopes assigned to your API key in the organisation settings.

2

Add the required scope for this endpoint to your API key.

3

Use an API key with no scope restrictions (full access) if you need access to all endpoints.

System Logs

For detailed system information about this error, check the system logs in your BizKitHub Admin dashboard. We provide transparent access to all system logs including detailed error information, request traces, and debugging data.

Need Help?

If you're still experiencing issues after following the troubleshooting steps, our support team is here to help.

Contact Support

Last updated: April 3, 2026