Sign inStart for free
    1. Note
    2. /Note

    Note

    Notes are rich text documents that reference a single parent Record.

    List Notes

    List Notes for all Records or for a specific Record.

    Scopes

    • note:readrequired
    • record_permission:readrequired
    • object_configuration:readrequired

    Query params

    limitinteger

    The maximum number of results to return. The default is 10 and the maximum is 50. See the full guide to pagination here.

    offsetinteger

    The number of results to skip over before returning. The default is 0. See the full guide to pagination here.

    parent_objectstring

    The Slug or ID of the Parent Object the Notes belong to.

    parent_record_idstring

    The ID of the Parent Record the Notes belong to.

    Format: UUID

    Response

    Status code

    Description

    Request

    GET
    /v2/notes
    curl https://api.attio.com/v2/notes?limit=10&offset=5&parent_object=people&parent_record_id=bf071e1f-6035-429d-b874-d83ea64ea13b \
      -H "Authorization: Bearer <token>"

    Response

    200 - Success

    {
      "data": [
        {
          "id": {
            "note_id": "ff3f3bd4-40f4-4f80-8187-cd02385af424",
            "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
          },
          "title": "Initial Prospecting Call Summary",
          "created_at": "2022-11-21T13:22:49.061281000Z",
          "parent_object": "people",
          "created_by_actor": {
            "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
            "type": "workspace-member"
          },
          "parent_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",
          "content_plaintext": "Introduction\nDate and time of the call\nParticipants\nPurpose of the call\nCustomer Background\nCompany overview (industry, size, location)\nKey business challenges\nCurrent software solutions (if any) and pain points"
        }
      ]
    }

    Create a Note

    Creates a new Note for a given Record.

    At present, Notes can only be created from plaintext without formatting.

    Scopes

    • note:read-writerequired
    • record_permission:readrequired
    • object_configuration:readrequired

    Request Body

    dataobject

    REQUIRED

    Response

    Status code

    Description

    Request

    POST
    /v2/notes
    curl https://api.attio.com/v2/notes \
      -H "Authorization: Bearer <token>" \
      -H "Content-Type: application/json" \
      -d @- << EOF
        {
          "data": {
            "title": "Initial Prospecting Call Summary",
            "format": "plaintext",
            "content": "Introduction\nDate and time of the call\nParticipants\nPurpose of the call\nCustomer Background\nCompany overview (industry, size, location)\nKey business challenges\nCurrent software solutions (if any) and pain points",
            "parent_object": "people",
            "parent_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b"
          }
        }
    EOF

    Response

    200 - Success

    {
      "data": {
        "id": {
          "note_id": "ff3f3bd4-40f4-4f80-8187-cd02385af424",
          "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
        },
        "title": "Initial Prospecting Call Summary",
        "created_at": "2022-11-21T13:22:49.061281000Z",
        "parent_object": "people",
        "created_by_actor": {
          "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
          "type": "workspace-member"
        },
        "parent_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",
        "content_plaintext": "Introduction\nDate and time of the call\nParticipants\nPurpose of the call\nCustomer Background\nCompany overview (industry, size, location)\nKey business challenges\nCurrent software solutions (if any) and pain points"
      }
    }

    Get a Note

    Get a single Note by ID.

    Scopes

    • note:readrequired
    • record_permission:readrequired
    • object_configuration:readrequired

    Path params

    note_idstring

    REQUIRED

    A UUID which identifies the Note.

    Format: UUID

    Response

    Status code

    Description

    Request

    GET
    /v2/notes/:note_id
    curl https://api.attio.com/v2/notes/ff3f3bd4-40f4-4f80-8187-cd02385af424 \
      -H "Authorization: Bearer <token>"

    Response

    200 - Success

    {
      "data": {
        "id": {
          "note_id": "ff3f3bd4-40f4-4f80-8187-cd02385af424",
          "workspace_id": "14beef7a-99f7-4534-a87e-70b564330a4c"
        },
        "title": "Initial Prospecting Call Summary",
        "created_at": "2022-11-21T13:22:49.061281000Z",
        "parent_object": "people",
        "created_by_actor": {
          "id": "50cf242c-7fa3-4cad-87d0-75b1af71c57b",
          "type": "workspace-member"
        },
        "parent_record_id": "bf071e1f-6035-429d-b874-d83ea64ea13b",
        "content_plaintext": "Introduction\nDate and time of the call\nParticipants\nPurpose of the call\nCustomer Background\nCompany overview (industry, size, location)\nKey business challenges\nCurrent software solutions (if any) and pain points"
      }
    }

    Delete a Note

    Delete a single Note by ID.

    Scopes

    • note:read-writerequired

    Path params

    note_idstring

    REQUIRED

    A UUID which identifies the Note to delete.

    Format: UUID

    Response

    Status code

    Description

    Request

    DELETE
    /v2/notes/:note_id
    curl https://api.attio.com/v2/notes/ff3f3bd4-40f4-4f80-8187-cd02385af424 \
      -H "Authorization: Bearer <token>" \
      -X DELETE

    Response

    200 - Success

    {}
    Terms & conditionsPrivacy policySecurity