Get

Description

Retrieve a single note. Notes were previously called annotations and all the APIs below will continue to support that nomenclature - simply replace note with annotation in the documentation below.

Request

HTTP Method: GET

Parameter Description
id The ID of the note to retrieve.
curl -X GET \
  https://<tenant-domain>/api/v1/notes/<note-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 note.

Field description

Parameter Description
id The note ID.
story_id ID of story to which the note belongs.
content The note 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"
}
Was this helpful?