Notes

Notes are pieces of textual (HTML-formatted) information that can be attached to Deals, Persons and Organizations. Notes are usually displayed in the UI in chronological order – newest first – and in context with other updates regarding the item they are attached to. The maximum note size is approximately 3,000,000 characters (or 3MB per note).

Get all notes

Copy link
Copy to clipboard
GET

/v1/notes

Returns all notes.

Query parameters

user_id

integer

The ID of the user whose notes to fetch. If omitted, notes by all users will be returned.

lead_id

string

The ID of the lead which notes to fetch. If omitted, notes about all leads with be returned.

Format

uuid

deal_id

integer

The ID of the deal which notes to fetch. If omitted, notes about all deals with be returned.

person_id

integer

The ID of the person whose notes to fetch. If omitted, notes about all persons with be returned.

org_id

integer

The ID of the organization which notes to fetch. If omitted, notes about all organizations with be returned

start

integer

Pagination start

Default

0

limit

integer

Items shown per page

sort

string

Field names and sorting mode separated by a comma (field_name_1 ASC, field_name_2 DESC). Only first-level field keys are supported (no nested keys). Supported fields: id, user_id, deal_id, person_id, org_id, content, add_time, update_time.

start_date

string

Date in format of YYYY-MM-DD from which notes to fetch.

Format

date

end_date

string

Date in format of YYYY-MM-DD until which notes to fetch to.

Format

date

pinned_to_lead_flag

number

If set, then results are filtered by note to lead pinning state

Values

0

1

pinned_to_deal_flag

number

If set, then results are filtered by note to deal pinning state

Values

0

1

pinned_to_organization_flag

number

If set, then results are filtered by note to organization pinning state

Values

0

1

pinned_to_person_flag

number

If set, then results are filtered by note to person pinning state

Values

0

1

Response
200

Get all Notes

Expand all
Copy code
    • true
    • [ ... ]
      • { ... }

      Get one note

      Copy link
      Copy to clipboard
      GET

      /v1/notes/{id}

      Returns details about a specific note.

      Path parameters

      id

      integer

      required

      ID of the note

      Response
      200

      Add, update or get a Note

      Expand all
      Copy code
        • true
        • { ... }

        Add a note

        Copy link
        Copy to clipboard
        POST

        /v1/notes

        Adds a new note.

        Body parameters

        application/x-www-form-urlencoded

        content

        string

        required

        Content of the note in HTML format. Subject to sanitization on the back-end.

        user_id

        integer

        ID of the user who will be marked as the author of this note. Only an admin can change the author.

        lead_id

        string

        The ID of the lead the note will be attached to

        Format

        uuid

        deal_id

        integer

        The ID of the deal the note will be attached to

        person_id

        integer

        The ID of the person this note will be attached to

        org_id

        integer

        The ID of the organization this note will be attached to

        add_time

        string

        Optional creation date & time of the Note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS

        pinned_to_lead_flag

        If set, then results are filtered by note to lead pinning state (lead_id is also required)

        Values

        0

        1

        pinned_to_deal_flag

        If set, then results are filtered by note to deal pinning state (deal_id is also required).

        Values

        0

        1

        pinned_to_organization_flag

        If set, then results are filtered by note to organization pinning state (org_id is also required).

        Values

        0

        1

        pinned_to_person_flag

        If set, then results are filtered by note to person pinning state (person_id is also required).

        Values

        0

        1

        Response
        200

        Add, update or get a Note

        Expand all
        Copy code
          • true
          • { ... }

          Update a note

          Copy link
          Copy to clipboard
          PUT

          /v1/notes/{id}

          Updates a note.

          Path parameters

          id

          integer

          required

          ID of the note

          Body parameters

          application/x-www-form-urlencoded

          content

          string

          required

          Content of the note in HTML format. Subject to sanitization on the back-end.

          user_id

          integer

          ID of the user who will be marked as the author of this note. Only an admin can change the author.

          lead_id

          string

          The ID of the lead the note will be attached to

          Format

          uuid

          deal_id

          integer

          The ID of the deal the note will be attached to

          person_id

          integer

          The ID of the person this note will be attached to

          org_id

          integer

          The ID of the organization this note will be attached to

          add_time

          string

          Optional creation date & time of the Note in UTC. Can be set in the past or in the future. Requires admin user API token. Format: YYYY-MM-DD HH:MM:SS

          pinned_to_lead_flag

          If set, then results are filtered by note to lead pinning state (lead_id is also required)

          Values

          0

          1

          pinned_to_deal_flag

          If set, then results are filtered by note to deal pinning state (deal_id is also required).

          Values

          0

          1

          pinned_to_organization_flag

          If set, then results are filtered by note to organization pinning state (org_id is also required).

          Values

          0

          1

          pinned_to_person_flag

          If set, then results are filtered by note to person pinning state (person_id is also required).

          Values

          0

          1

          Response
          200

          Add, update or get a Note

          Expand all
          Copy code
            • true
            • { ... }

            Delete a note

            Copy link
            Copy to clipboard
            DELETE

            /v1/notes/{id}

            Deletes a specific note.

            Path parameters

            id

            integer

            required

            ID of the note

            Response
            200

            Delete a Note

            Expand all
            Copy code
              • true
              • true

            Subscribe to Pipedrive’s Developer Newsletter