GET /notes

Returns all notes.

Servers

Query parameters

Name Type Required Description
person_id Integer No

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

project_id Integer No

The ID of the project which notes to fetch. If omitted, notes about all projects will be returned.

sort String No

The 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.

org_id Integer No

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

pinned_to_lead_flag Number No

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

Possible values:

  • 0
  • 1
deal_id Integer No

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

lead_id String No

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

limit Integer No

Items shown per page

start_date String No

The date in format of YYYY-MM-DD from which notes to fetch

end_date String No

The date in format of YYYY-MM-DD until which notes to fetch to

pinned_to_organization_flag Number No

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

Possible values:

  • 0
  • 1
pinned_to_person_flag Number No

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

Possible values:

  • 0
  • 1
pinned_to_deal_flag Number No

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

Possible values:

  • 0
  • 1
start Integer No

Pagination start

Default value: 0

pinned_to_project_flag Number No

If set, the results are filtered by note to project pinning state

Possible values:

  • 0
  • 1
user_id Integer No

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

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.