Developer API Guide

The LabHQ Developer API is a secure, versioned REST API for integrating external systems with LabHQ. It provides programmatic access to supported LabHQ data and workflows without requiring users to work through the LabHQ web application.

Interactive API documentation

The interactive Swagger documentation contains the available endpoints, parameters, request and response schemas, and HTTP status codes:

Open the LabHQ Developer API documentation

The API base URL is:

https://api.labhqlims.com/v1

The OpenAPI specification is also available for use with API development and code-generation tools:

https://api.labhqlims.com/swagger/v1/swagger.json

Authentication

All requests require a Developer API access token. Each token is specific to a LabHQ organisation and should be stored securely.

Send the token using the standard bearer authentication header:

Authorization: Bearer {access-token}

To test a request in Swagger:

1. Select [Authorize].

2. Enter your access token.

3. Select an endpoint and then select [Try it out].

Contact LabHQ Support if you need a Developer API access token using this guide.

Versioning

The current supported major version is v1 . All version 1 endpoint paths begin with /v1 .

Compatible additions may be made within the current version. Breaking contract changes will be introduced under a new major version.

Collection endpoints use limit and offset query parameters. The default limit is 20 records and the maximum is 100 records per request.

Paginated responses include the returned items, total record count, limit and offset.

Important behaviour

- Custom field values must use the field position configured in LabHQ.

- Date and time values are handled in UTC.

Responses and errors

The API uses standard HTTP status codes. Successful create requests return `201 Created`, successful requests without a response body return `204 No Content`, and validation or resource errors return the appropriate `4xx` status.

Error responses use the standard Problem Details JSON format and include a stable `code` value for integration error handling. Include the response trace ID when contacting LabHQ Support about an error.

Support

Contact LabHQ Support if you need help accessing, understanding or integrating with the

API. Please include any relevant details that will help us investigate your request.