YQueue DocsDevelopers

Guide

Introduction

Read YQueue's public API documentation for the conventions shared by these private APIs.

API version

Send X-API-VERSION to select the API version your client supports:

X-API-VERSION: 29-10-2026

29-10-2026 is the latest and default version. Requests without this header use that version. Clients that depend on an older response format should explicitly select a supported older version.

See the changelog for changes between versions.

Mock error responses

In staging and local environments, send X-RESPONSE-MOCK to test how your client handles an API error:

X-RESPONSE-MOCK: bad-request

The API returns the HTTP status and error code associated with the header value:

Header value HTTP status Error code
bad-request 400 bad_request
unsupported-api-version 400 unsupported_api_version
unauthorised 401 unauthorised
forbidden 403 forbidden
not-found 404 not_found
conflict 409 conflict
server-error 500 server_error

Override geolocation

In staging and local environments, send X-GEOLOCATION-OVERRIDE with a supported country code, such as SG or AU, to test country-specific behaviour:

X-GEOLOCATION-OVERRIDE: SG

To simulate a geolocation lookup failure, use FAILURE (case sensitive). Unsupported values are ignored and the normal IP lookup runs instead. These testing headers are ignored in production.

Search documentation

Search across this documentation site.