List

Description

List notes.

Request

HTTP Method: GET

Parameter Description
story_id Optional List notes for the given story
mode Optional List notes for the given story mode (LIVE or TEST, must be used with story_id)
team_id Optional List notes for the given team
group_id Optional List notes for the given group
per_page Optional Set the number of results returned per page.
page Optional Specify the page of results to return if there are multiple pages. Defaults to page 1. 
curl -X GET \
  https://<<META.tenant.domain>>/api/v1/notes/ \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful request will return an array listing the requested notes.

Field description

Parameter Description
id The note ID.
story_id ID of story to which the note belongs.
story_mode Mode of the story to which the note belongs LIVE or TEST
group_id ID of group 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

{
  "annotations": [
    {
      "id": 21405,
      "story_id": 813,
      "story_mode": "LIVE",
      "group_id": null,
      "position": {
        "x": 0,
        "y": 0
      },
      "content": "# Example note"
    }
  ],
  "meta": {
    "current_page": "https://<<META.tenant.domain>>/api/v1/notes?per_page=20&page=1",
    "previous_page": null,
    "next_page": null,
    "next_page_number": null,
    "per_page": 20,
    "pages": 1,
    "count": 1
  }
}
Was this helpful?