InboxIssue

Authentication

API authentication and token management

Authentication

All InboxIssue API requests require Bearer token authentication.

API Token

Include your API token in the Authorization header:

Authorization: Bearer YOUR_API_TOKEN

Obtaining an API Token

  1. Log in to InboxIssue
  2. Navigate to Settings > API Tokens
  3. Click Generate New Token
  4. Copy and securely store your token (it won't be shown again)

API access is available on Pro and Enterprise plans only.

Example Request

curl -X GET "https://app.inboxissue.com/api/v1/external_tests/providers" \
  -H "Authorization: Bearer your_api_token_here" \
  -H "Content-Type: application/json"

Base URL

All API endpoints use this base URL:

https://app.inboxissue.com/api/v1

Authentication Errors

Status CodeErrorDescription
401UnauthorizedMissing or invalid API token
403ForbiddenAPI access not available on your plan

401 Unauthorized

{
  "success": false,
  "error": "Invalid or missing API token"
}

Solutions:

  • Verify your API token is correct
  • Check that the token hasn't been revoked
  • Ensure the Authorization header is properly formatted

403 Forbidden

{
  "success": false,
  "error": "API access not available on your subscription plan"
}

Solution: Upgrade to Pro or Enterprise plan to access the API.

Token Best Practices

Security

  • Store tokens securely (use environment variables, secrets managers)
  • Never commit tokens to version control
  • Rotate tokens periodically
  • Use different tokens for different applications

Example: Environment Variable

# .env file
INBOXISSUE_API_TOKEN=your_api_token_here
 
# Usage
curl -X GET "https://app.inboxissue.com/api/v1/external_tests" \
  -H "Authorization: Bearer $INBOXISSUE_API_TOKEN"

Rate Limits

API requests are rate-limited based on your subscription plan:

PlanRequests/Hour
Pro1,000
Enterprise10,000

Rate limit headers are included in responses:

HeaderDescription
X-RateLimit-LimitMaximum requests per hour
X-RateLimit-RemainingRequests remaining
X-RateLimit-ResetUnix timestamp when limit resets

429 Too Many Requests

{
  "success": false,
  "error": "Rate limit exceeded. Try again in 60 seconds."
}

On this page