List notes

v1.0.0

List notes for all records or for a specific record.

This endpoint is temporarily rate limited to 10 requests per second.

Required scopes: note:read, object_configuration:read, record_permission:read.

Input

{
  "type": "object",
  "properties": {
    "limit": {
      "type": "integer",
      "description": "The maximum number of results to return. The default is `10` and the maximum is `50`. See the [full guide to pagination here](/rest-api/guides/pagination)."
    },
    "offset": {
      "type": "integer",
      "description": "The number of results to skip over before returning. The default is `0`. See the [full guide to pagination here](/rest-api/guides/pagination)."
    },
    "parent_object": {
      "type": "string",
      "description": "The slug or ID of the parent object the notes belong to."
    },
    "parent_record_id": {
      "type": "string",
      "format": "uuid",
      "description": "The ID of the parent record the notes belong to."
    }
  },
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "Success",
  "required": [
    "data"
  ],
  "properties": {
    "data": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "id",
          "parent_object",
          "parent_record_id",
          "title",
          "meeting_id",
          "content_plaintext",
          "content_markdown",
          "tags",
          "created_by_actor",
          "created_at"
        ],
        "properties": {
          "content_markdown": {
            "type": "string",
            "description": "The markdown representation of the note content. Supports a subset of markdown features including:\n- Headings (levels 1-3 only with `#`, `##`, `###`)\n- Unordered lists (`-`, `*`, `+`)\n- Ordered lists (`1.`, `2.`, etc.)\n- Text styling: `**bold**`, `*italic*`, `~~strikethrough~~`, `==highlighted==`\n- Links: `[link text](https://example.com)`\n\nNote that note images are not returned as part of the markdown API representation."
          },
          "content_plaintext": {
            "type": "string",
            "description": "The plaintext representation of the note content. The line feed character `\\n` represents new lines within the note content."
          },
          "created_at": {
            "type": "string",
            "description": "When the note was created."
          },
          "created_by_actor": {
            "type": "object",
            "description": "The actor that created this note.",
            "properties": {
              "id": {
                "type": "string",
                "description": "An ID to identify the actor."
              },
              "type": {
                "type": "string",
                "description": "The type of actor. [Read more information on actor types here](/docs/actors).",
                "enum": [
                  "api-token",
                  "workspace-member",
                  "system",
                  "app"
                ]
              }
            }
          },
          "id": {
            "type": "object",
            "required": [
              "workspace_id",
              "note_id"
            ],
            "properties": {
              "note_id": {
                "type": "string",
                "format": "uuid",
                "description": "The ID of the note."
              },
              "workspace_id": {
                "type": "string",
                "format": "uuid",
                "description": "The ID of the workspace the note belongs to."
              }
            }
          },
          "meeting_id": {
            "type": [
              "string",
              "null"
            ],
            "format": "uuid",
            "description": "The ID of the meeting associated with this note, or null if no meeting is associated."
          },
          "parent_object": {
            "type": "string",
            "description": "The slug or ID of the parent object the note belongs to."
          },
          "parent_record_id": {
            "type": "string",
            "format": "uuid",
            "description": "The ID of the parent record the note belongs to."
          },
          "tags": {
            "type": "array",
            "description": "An array of records or workspace members that are @-tagged in the note content.",
            "items": {
              "type": "object"
            }
          },
          "title": {
            "type": "string",
            "description": "The note title. The title is plaintext only and has no formatting."
          }
        }
      }
    }
  }
}