Notes

The Notes API provides a simple interface to manage notes. The API allows you to create, delete and update your notes. You can retrieve a single note as well as list of all notes.

You can assign as many notes as you want to any of the resources listed below:

Properties

Attribute Description
id number readonly

Unique identifier of the note.

creator_id number readonly

Unique identifier of the user that created the note.

resource_type string

Type name of the resource the note is attached to.

Possible values:

  • lead
  • contact
  • deal
resource_id number

Unique identifier of the resource the note is attached to.

content string

Content of the note.

created_at string readonly

Date and time of creation in UTC (ISO8601 format).

updated_at string readonly

Date and time of the last update in UTC (ISO8601 format).


Endpoints


Retrieve all notes

Returns all notes available to the user, according to the parameters provided.

Parameters

Attribute Description
page number optional

Page number to start from. Page numbering starts at 1, and omitting the page parameter will return the first page.

e.g. ?page=2
per_page number optional

Number of records to return per page. The default limit is 25 and the maximum number that can be returned at one time is 100.

e.g. ?per_page=20
sort_by string optional

A field to sort by. Default ordering is ascending. If you want to change the sort ordering to descending, append :desc to the field e.g. sort_by=resource_type:desc.

Possible values:

  • resource_type
  • created_at
  • updated_at
e.g. ?sort_by=created_at
includes string optional

Comma-separated list of one or more resources related to the note. Not supported at the moment.

ids string optional

Comma-separated list of note IDs to be returned in a request.

e.g. ?ids=1,2,3
creator_id number optional

Unique identifier of the user. Returns all notes created by the user.

e.g. ?creator_id=1
q string optional

A query string to search for. Performs a full text search on the content field.

e.g. ?q=important
resource_type string optional

Name of the type of resource to search for.

Possible values:

  • lead
  • contact
  • deal
e.g. ?resource_type=lead
resource_id number optional

Unique identifier of the resource to search for.

e.g. ?resource_id=1

Create a note

Create a new note and associate it with one of the resources listed below:

Parameters

Attribute Description
resource_type string required
e.g. "resource_type": "lead"
resource_id number required
e.g. "resource_id": "1"
content string required
e.g. "content": "Highly important."

Retrieve a single note

Returns a single note available to the user, according to the unique note ID provided. If the note ID does not exist, this request will return an error.

Parameters

Attribute Description
id number required

Unique identifier of the note.


Update a note

Updates note information. If the note ID does not exist, this request will return an error.

Parameters

Attribute Description
resource_type string optional
e.g. "resource_type": "lead"
resource_id number optional
e.g. "resource_id": "1"
content string optional
e.g. "content": "Highly important. Assign to Tom."

Delete a note

Delete an existing note. If the note ID does not exist, this request will return an error. This operation cannot be undone.

Parameters

Attribute Description
id number required

Unique identifier of the note.