Note

Something written down about a client, a project or a contact — or nothing in particular, in which case it sits on its own in the workspace.

  • created_at
    Type: string Format: date-time
    required

    When the note was written.

  • created_by_member_id
    Type: integer | null
    required

    Team member id of the author, or null when they are no longer a member of your account.

  • date
    Type: string | null Format: date
    required

    The day the note is about, which is what the app sorts and groups notes by. Defaults to today in your account timezone.

  • id
    Type: string Format: uuid
    required

    Unique identifier for the note.

  • note_links
    Type: array object[] · NoteLink[]
    required

    The records this note is attached to, leaving out any your token cannot reach. Empty for a workspace note that stands on its own.

    The attachment between a note and one of the records it is written about.

    • id
      Type: integer
      required

      Unique identifier for the attachment between the note and the record.

    • record_id
      Type: integer
      required

      Id of the attached record, in the resource named by record_type.

    • record_type
      Type: string | null enum
      required

      Which kind of record the note is attached to.

      values
      • company
      • project
      • contact
  • title
    Type: string
    required

    Note title. Empty when the note was written without one.

  • updated_at
    Type: string Format: date-time
    required

    When the note was last edited.

  • visibility
    Type: string enum
    required

    everyone for a note the whole account can read, author_only for one only its author can. Notes written through the API are visible to everyone.

    values
    • everyone
    • author_only