BETA

Skip links

  • Skip to primary navigation
  • Skip to content
  • Skip to footer
Queensland government logo Queensland government logo
Sign in Sign out
Sign in
  • Profile summary
  • Sign out
Department of Education Department of Education Developer Portal
  • Home
  • Tags
  • Chat
  • Beta
    APIs
  • Help
  • Contact us
  • Dark mode
  • Home
  • Tags
  • Chat
  • Beta
    APIs
  • Help
  • Contact us
  • My profile
  • Dark mode

Troubleshooting API issues

Jeny Amatya Government Popular Admin
by Jeny Amatya
12 September 2025
Last updated 12 September 2025
API Getting started
API Getting started

Overview

When calling API endpoints from Postman or your application, you may encounter issues related to authentication, headers, or request formatting.
This guide lists common problems and their solutions so you can quickly diagnose and resolve them.

Authentication issues πŸ”‘

Symptom:
You receive an error such as:

  • 401 Unauthorized
  • 403 Forbidden

How to fix:
βœ” Ensure you have created a valid application key in the Developer Portal.
βœ” Add the key to the request header:

Key Value
X-API-KEY your API key

βœ” If you are using environment variables in Postman (e.g., ``), double-check that the variable is set and selected in the current environment.
βœ” If you deleted or rotated your key, generate a new one and update it everywhere it’s used.

Missing or incorrect headers πŸ“

Symptom:
The request fails, or you receive an unexpected response (e.g., 400 Bad Request).

How to fix:
βœ” Confirm the X-API-KEY header is present.
βœ” Make sure there are no typos in the header name or value.
βœ” Check that the Content-Type header is set appropriately (e.g., application/json for JSON requests).

Expired or invalid tokens (if applicable) ⏳

Symptom:
You receive 401 Unauthorized even though your API key or token was working earlier.

How to fix:
βœ” If the API requires short-lived tokens, refresh or regenerate them.
βœ” In Postman, re-run the authentication request (if applicable) to fetch a new token.
βœ” In your application, implement token refresh logic to avoid downtime.

Common HTTP errors and fixes ⚠️

Error Code Meaning Possible Fix
400 Bad Request Check query parameters, request body, and header formatting.
401 Unauthorized Verify API key, tokens, and authentication headers.
403 Forbidden Ensure your key has permission to access the endpoint.
404 Not Found Check that you are calling the correct endpoint and URL path.
429 Too Many Requests You may have hit rate limits. Wait and try again later.
500 Internal Server Error Retry after a few seconds. If it persists, contact support.

Common pitfalls 🧰

βœ” Using the wrong environment:
Make sure you are calling the correct environment (sandbox vs. production).

βœ” Forgetting to save headers:
In Postman, save the header and parameter setup in a collection to avoid re-entering every time.

βœ” Incorrect base URL:
Double-check that your `` variable or endpoint URL is correct and has no trailing slashes or typos.

βœ” Calling endpoints without parameters:
Some endpoints require query parameters (e.g., centreCode, zoneId). Missing parameters may return empty results.

βœ” Using an expired key:
If you deleted or rotated the key, older requests will fail until updated.

Need help? πŸ†˜

If issues persist after troubleshooting:
βœ” Refer to the Quick start guides.
βœ” Check the API activity log in the Developer Portal for clues (e.g., failed request counts).
βœ” Contact the support team with the error message, request details, and timestamp for faster resolution.

Powered by Link to AI chat
  • Copyright
  • Disclaimer
  • Privacy
  • Right to information
  • Accessibility
  • Jobs in Queensland Government
  • Other languages

© The State of Queensland (Department of Education) 2025

Queensland Government