API Reference

The API v2 Reference provides the technical specification for every API endpoint.

For each endpoint, the reference documentation includes:

• The endpoint URL and HTTP method.

• The purpose of the endpoint.

• Authentication requirements.

• Request body and query parameters.

• Response schema.

• Example requests and responses.

• Possible error responses.

The reference documentation is organised by resource, making it easy to locate the endpoints relevant to your integration.

Access the API Reference

To view the API v2 Reference:

1. From the Utilities menu, go to Apps.

2. Locate the Equator API app and click View.

3. Open the Version 2 tab.

4. In the API v2 Usage section, click API v2 Docs.

Trying Endpoints

The API Reference allows you to execute requests directly from the documentation.

To test an endpoint:

1. Open the endpoint you want to test.

2. Click Try It.

3. Enter the required request details.

4. Provide a valid API token when prompted for authentication.

5. Execute the request to view the response.

This provides a convenient way to explore and validate API behaviour without leaving the documentation.