Health Platform GroupDevelopersContact our team
Browse documentation
API referenceAPI overview

API reference

API reference

These examples explain request headers, response formats and error handling. They are illustrative patterns, not a published production API contract. Use the specification supplied for your agreed integration.

Authentication

Make authenticated requests from your server. Keep credentials in environment variables or a secrets manager, and follow the authentication scheme supplied for your integration.

Example request headers
Authorization: Bearer YOUR_API_KEY
Accept: application/json

Never place a secret key in browser JavaScript, a public repository or a support ticket.

List services

Example request

A simple read request demonstrates the shape of a service catalogue response. The available services and fields depend on your connection.

GET/v1/servicesService catalogue
Request
curl "https://api.example.com/v1/services" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --header "Accept: application/json"

Response object

Read the response as JSON and validate the fields your application depends on. Here’s a small sample of a catalogue object.

Response · JSON
{
  "data": [
    {
      "id": "service_example",
      "name": "Example healthcare service",
      "type": "consultation"
    }
  ]
}
FieldTypeDescription
dataarrayA list of service objects.
data[].idstringA service identifier.
data[].namestringA human-readable service name.
data[].typestringThe service category.

Handling errors

Check the response status before processing the body. Keep useful diagnostic details in your server logs and show customers a clear, actionable message.

StatusMeaningNext step
200OKProcess the successful response.
400Bad requestCheck required fields and request formatting.
401UnauthorisedReview credentials and authentication headers.
429Rate limitedRespect retry guidance from the endpoint.
5xxServer errorFollow the agreed retry and escalation policy.

Confirm endpoint-specific status codes, limits and retry rules in your integration specification.

Need a hand?Troubleshoot your integrationCommon checks and how to put together a useful bug report.

Browse documentation