Get

Description

Retrieve a single annotation.

Request

HTTP Method: GET

Parameter Description
id The ID of the annotation to retrieve.
curl -X GET \
  https://<tenant-domain>/api/v1/annotations/<annotation-id> \
  -H 'content-type: application/json' \
  -H 'x-user-email: <email-address' \
  -H 'x-user-token: <api-token>'

Response

A successful request will return a JSON object representing the specified annotation.

Field description

Parameter Description
id The annotation ID.
story_id ID of story to which the annotation belongs.
content The annotation Markdown formatted content.
position An object describing the XY coordinates of the position on the story diagram.

Sample response

{
  "id": 21405,
  "story_id": 813,
  "position": {
    "x": 0,
    "y": 0
  },
  "content": "# Header\n This is a list \n - item 1"
}