Skip to main content

API Reference

WildTrack360 ships a live, interactive API reference so developers and integrators can explore every endpoint the application exposes without reading the source code.

:::info Who this is for This page is for technical users building integrations or automations against your WildTrack360 instance. If you only use the web app, you can safely skip it. :::

What's available​

SurfaceURLWhat it is
Interactive reference/api/docsA browsable Scalar UI listing every route, its parameters, request body, and response shapes — with a built-in "try it" console.
Raw specification/api/openapiThe underlying OpenAPI 3.1 document (JSON), suitable for importing into Postman, Insomnia, code generators, or your own tooling.

Both are served from your organisation's own instance — append the paths to your WildTrack360 URL (for example https://your-org.wildtrack360.com.au/api/docs).

Accessing the reference​

  • In production, both routes require you to be signed in. Any authenticated user can view them — no admin role is needed.
  • In local development, the routes are open (no sign-in) for convenience.

Beyond viewing the documentation, calling the API endpoints themselves is still governed by the usual roles and permissions — the reference shows you what exists, but each request is authorised the same way the web app is.

How it stays accurate​

The specification is generated from route contracts in the code. Contracted routes use Zod schemas for validation and published request and response details. A continuous-integration check catches undocumented drift.

:::note Community beta API The new /api/community routes are used by the Community beta, but they do not yet have individual OpenAPI contracts. They are excluded from the generated reference until those contracts are added. :::

Using the spec in your own tools​

  1. Sign in to your WildTrack360 instance.
  2. Download the document from /api/openapi.
  3. Import it into your API client (Postman, Insomnia, etc.) or feed it to an OpenAPI code generator to scaffold a typed client.

:::note Internal API The API is primarily the interface the WildTrack360 web app uses to talk to its own backend. It is documented for transparency and integration work, but it is not a separately versioned public product — endpoints may change between releases. Pin to a known instance and re-check the spec after upgrades. :::

:::tip Connecting an AI assistant? If you want to connect an AI chat client (Claude, ChatGPT, Cursor, Claude Code) rather than build a custom integration, use the MCP Server instead — it exposes a curated, permission-scoped set of tools over Clerk OAuth, so the client acts as you with your exact role and species access. :::