OpenAPI and schema

GET/api/v2/schema#

Returns a machine-readable description of the trackagoat data model. Designed for AI agents that need to understand entity types, field names, and relationships without reading source code.

Request#

curl -H "Authorization: Bearer tga_<key>" \
  https://www.trackagoat.com/api/v2/schema

When to use this#

Call /api/v2/schema when you first connect to the API to get a full picture of available entities and their fields. The response is stable across minor API updates: field names and types won't change without a version bump.

Response#

The schema endpoint returns an object describing each entity type, its fields, and key relationships. The exact shape is controlled server-side and may expand over time.

Since Trackagoat 2.0 the model is multi-platform: it now includes the account and content group entities alongside creators and videos. A creator owns many accounts, videos hang off accounts, and a content group links the same logical content across platforms.

{
  "data": {
    "entities": {
      "project": { "fields": {...}, "description": "..." },
      "creator": { "fields": {...}, "description": "..." },
      "account": { "fields": {...}, "description": "..." },
      "video": { "fields": {...}, "description": "..." },
      "content_group": { "fields": {...}, "description": "..." },
      "campaign": { "fields": {...}, "description": "..." }
    },
    "relationships": [...]
  },
  "error": null,
  "meta": null
}