Skip to content
More support Support portal
Contact us
  • There are no suggestions because the search field is empty.

Public API Reference

Access the technical documentation for quickclaim Public APIs and understand their availability, environments and limitations.

quickclaim Public APIs provide simplified access primarily to data stored and maintained in quickclaim.

They are available only to organisations using quickclaim v1.

Important: Public APIs are not available with quickclaim v2 and cannot be used to submit NDIS claims.

Technical documentation

The complete Public API technical reference is maintained in Postman:

Open the quickclaim Public API documentation

Use the Postman documentation to find:

  • Available endpoints
  • Request methods and URLs
  • Required headers
  • Path and query parameters
  • Request body definitions
  • Response schemas
  • Request and response examples

Postman is the source of truth for Public API endpoint specifications. Endpoint definitions are not duplicated in this wiki to avoid conflicting or outdated information.

Public API availability
quickclaim version Availability
quickclaim v1 Available
quickclaim v2 Not available

If your organisation uses quickclaim v2, use the restricted Native API Reference instead.

How Public APIs work

quickclaim manages the underlying NDIS calls and background jobs used to retrieve and maintain data.

Public API requests primarily return information stored in quickclaim. Data freshness therefore depends on the endpoint and its refresh schedule.

If an endpoint performs a live NDIS request, this will be stated in the Postman documentation.

Public APIs are best suited to integrations that:

  • Need to retrieve information maintained in quickclaim
  • Prefer a simplified API structure
  • Do not need to submit NDIS claims
  • Do not need to manage each underlying NDIS request
Environments
Environment Base URL
Stage https://stage-api.quickclaim.io/public/
Production https://api.quickclaim.io/public/

Use the stage environment to develop and test your integration before moving to production.

For instructions on accessing stage and obtaining credentials, see Sandbox and Authentication.

Authentication

Public API requests require the following headers:

org-id: YOUR_ORGANISATION_ID x-api-key: YOUR_API_KEY

Use stage credentials with the stage URL and production credentials with the production URL.

Recommended process
  1. Confirm that your organisation uses quickclaim v1.
  2. Obtain stage credentials from the quickclaim stage Integration page.
  3. Open the Public API documentation.
  4. Select the endpoint required for your integration.
  5. Review its parameters, headers and response schema.
  6. Test the endpoint using the stage URL and stage credentials.
  7. Move to the production URL and credentials after testing is complete.
Public API limitations
  • Public APIs are not available with quickclaim v2.
  • Public APIs cannot submit NDIS claims.
  • Most responses contain stored quickclaim data rather than a new live NDIS response.
  • Data freshness varies by endpoint and background job schedule.
  • Only endpoints listed in the Postman documentation are supported.
Need help?

Contact support@quickclaim.io if you need help accessing the Public APIs, locating an endpoint or understanding its data-refresh behaviour.