List design notes

GET/v1/design/items/{id}/notes

Signed-in sessionLaunch key product.designOperation design_notes_list

An internal tool for the components agents build and the rules they follow.

Path parameters

idstringRequired

Query parameters

expectedAuthorizationVersionstring

Returns

itemsobject[]Required
morebooleanRequired
schemaVersion1Required

Errors

400, 401, 403, 404, 409, 429 and 503 return {"error": {"code", "message", "correlationId"}}.

GET/v1/design/items/{id}/notes

curl "$SPECIFY_API_ORIGIN/v1/design/items/<id>/notes" \
  -H "Authorization: Bearer $SPECIFY_SESSION_TOKEN" \
  -H "X-Specify-Account-Id: <accountId>" \
  -H "X-Specify-Service-Tenancy-Id: <serviceTenancyId>"

Response

{
  "result": {
    "items": [
      {
        "id": "<id>",
        "revisionId": "<revisionId>",
        "revisionNumber": "<revisionNumber>",
        "pin": "<pin>",
        "body": "<body>",
        "author": {
          "you": true,
          "kind": "agent",
          "name": "<name>"
        },
        "createdAt": 1,
        "version": 1,
        "changeRequestId": "<changeRequestId>",
        "answersNoteIds": [
          "<answersNoteId>"
        ]
      }
    ],
    "more": true,
    "schemaVersion": 1
  }
}