Skip to content

You are reading version v1.1, which is archived. See the current version

API access disabled

When the API answers 403 api_access_disabled, and how to fix it.

Version v1.1, updated

On this page

API access is not enabled for the company of the key. No key of that company works until it is.

At a glance

  • Status: 403 Forbidden

  • Code: api_access_disabled

  • Retry: No. Fix the cause first: the same request gets the same answer.

Causes and fixes

Likely cause

How to fix it

API access was never enabled for the company.

A company administrator asks BIRP support to enable it.

API access was turned off for the company.

A company administrator asks BIRP support why, and to enable it again.

Example

403 api_access_disabledJSON
{
  "code": "api_access_disabled",
  "detail": "API access is not enabled for the company. BIRP support can enable it.",
  "instance": "/v1/categories",
  "request_id": "a1b2c3d4-0000-4000-8000-0000000000ee",
  "status": 403,
  "title": "API access disabled",
  "type": "https://birp.io/developers/errors/api_access_disabled"
}
  • first-key
  • what-the-api-is-for
  • errors-overview