List Annotations

List annotations with optional filters.

Bearer token or X-API-Keyscope: org memberoperation_id: annotations.list

Authentication

Send either Authorization: Bearer <token> or X-API-Key: <token>. Any org token with sufficient scope. Create tokens from the console or the /v1/orgs/{org_id}/tokens endpoints. Requests without a valid credential are rejected with 401.

SDK install

pip install znyx-sdknpm install @znyx/sdk

Code samples

Request

curl -X GET "$ZNYX_API_URL/v1/orgs/00000000-0000-0000-0000-000000000000/annotations?limit=50&offset=0" \
  -H "Authorization: Bearer $ZNYX_TOKEN"

Response

application/json

Successful Response

{
  "total": 0,
  "limit": 0,
  "offset": 0,
  "annotations": [
    {
      "id": "string",
      "trace_id": "string",
      "annotation": "string",
      "detector_name": null,
      "notes": null,
      "annotated_by": null,
      "created_at": null
    }
  ]
}

Schema: object

Path parameters

Name	Type	Required	Description
org_id#path	string	required	-

Query parameters

Name	Type	Required	Description
trace_id#query	string \| null	optional	-
annotation_type#query	string \| null	optional	-
detector_name#query	string \| null	optional	-
limit#query	integer	optional	-
offset#query	integer	optional	-

Header parameters

Name	Type	Required	Description
X-API-Key#header	string \| null	optional	-
authorization#header	string \| null	optional	-

Responses

Status	Description
200	Successful Response
422	Validation Error

Response schema

totalrequiredinteger

limitrequiredinteger

offsetrequiredinteger

annotationsrequired

Errors & what triggers them

Code	Trigger	Fix
401	Missing or expired Authorization header.	-
403	Token does not have org access (wrong org_id, or insufficient role).	-
404	Resource does not exist in this org.	-