---
title: "Get an Annotation Category by Id or name"
method: GET
path: "/annotation_categories/{idOrName}"
tags: ["Annotations"]
---

# Get an Annotation Category by Id or name

`GET /annotation_categories/{idOrName}`

## Request

- Base URL: `https://connect-au.catapultsports.com/api/v6`
- URL: `https://connect-au.catapultsports.com/api/v6/annotation_categories/{idOrName}`
- Auth: HTTP bearer

This API will return the annotation category requested by Id or Name

## Path parameters

- `idOrName` string, required

## Response `200`

Annotation category

- object[]
  - `id` string
  - `name` string: Display name
  - `import_name` string: Internal name
  - `start_offset` integer: Pre-roll in whole seconds
  - `end_offset` integer: Post-roll in whole seconds
  - `default_color` string: HTML color, e.g. #FF5500, the color to use for annotations of this type
  - `is_bakeable` integer: 0(false) or 1(true) annotation category should be baked. If is_event = 1 then is_bakeable will be 0
  - `is_event` integer: 0(false) or 1(true). An event might be a single event in time (like a Goal Keeper Save) vs a period of time (like ball in possession)
  - `created_at` string
  - `modified_at` string
  - `is_editable` integer

## Other responses

- `401`: Unauthorized
- `404`: Not Found

---

[API](https://skmtc.dev/catapultsports/apis/openfield-connect-v6-api.md) - [All operations](https://skmtc.dev/catapultsports/apis/openfield-connect-v6-api/llms.txt) - [OpenAPI document](https://skmtc.dev/catapultsports/apis/openfield-connect-v6-api/revisions/4f0d7082f399?raw)