List Notes

GET 
/crm/notes

List notes based on a given criteria

Request

Query Parameters

credentialId stringrequired

The ID of the credential.

pageNumber string

The page number of the results. Default is 1.

pageSize int32

The maximum number of results to show on a page. Default is 50. Maximum is 100.

noteOwner string

Filter notes by the exact name of the note owner.

noteOwnerContains string

Filter notes where the note owner's name contains the specified string.

noteOwnerNotEquals string

Filter notes where the note owner's name is not the specified string.

noteContent string

Filter notes by the exact content of the note.

noteContentContains string

Filter notes where the content contains the specified string.

noteContentNotEquals string

Filter notes where the content is not the specified string.

noteContact string

Filter notes by the exact name or ID of the associated contact.

noteContactContains string

Filter notes where the associated contact's name or ID contains the specified string.

noteContactNotEquals string

Filter notes not associated with the specified contact name or ID.

noteAccount string

Filter notes by the exact name or ID of the associated account.

noteAccountContains string

Filter notes where the associated account's name or ID contains the specified string.

noteAccountNotEquals string

Filter notes not associated with the specified account name or ID.

noteOpportunity string

Filter notes by the exact name or ID of the associated opportunity.

noteOpportunityContains string

Filter notes where the associated opportunity's name or ID contains the specified string.

noteOpportunityNotEquals string

Filter notes not associated with the specified opportunity name or ID.

remoteCreatedAtMin date

Filter objects created in the third-party application after a specified date.

remoteCreatedAtMax date

Filter objects created in the third-party application before a specified date.

remoteUpdatedAtMin date

Filter objects last updated in the third-party application after a specified date.

remoteUpdatedAtMax date

Filter objects last updated in the third-party application before a specified date.

createdAtMin date

Filter objects created after a specified date.

createdAtMax date

Filter objects created before a specified date.

updatedAtMin date

Filter objects last updated after a specified date.

updatedAtMax date

Filter objects last updated before a specified date.

Header Parameters

Authorization stringrequired

Default value: bearer YOUR_API_KEY

Responses

200

200

application/json

Schema

Schema

notes

object[]

Array [

remoteId string

noteOwner string

noteTitle

noteContent string

noteContact string

noteAccount

noteOpportunity

createdTimestamp integer

Default value: 0

updatedTimestamp integer

Default value: 0

id string

]

pageInfo

object

hasNext boolean

Default value: true

nextCursor

Example (from schema)

{
  "notes": [
    {
      "remoteId": "5969180000000450730",
      "noteOwner": "5969180000000438001",
      "noteTitle": {},
      "noteContent": "Interested in learning more",
      "noteContact": "5969180000000450250",
      "noteAccount": {},
      "noteOpportunity": {},
      "createdTimestamp": 1698286277,
      "updatedTimestamp": 1698286277,
      "id": "0d284299-1a28-cd88-96d9-43e3d8940a96"
    }
  ],
  "pageInfo": {
    "hasNext": false,
    "nextCursor": {}
  }
}

Result

{
  "notes": [
    {
      "remoteId": "5969180000000450730",
      "noteOwner": "5969180000000438001",
      "noteTitle": null,
      "noteContent": "Interested in learning more",
      "noteContact": "5969180000000450250",
      "noteAccount": null,
      "noteOpportunity": null,
      "createdTimestamp": 1698286277,
      "updatedTimestamp": 1698286277,
      "id": "0d284299-1a28-cd88-96d9-43e3d8940a96"
    },
    {
      "remoteId": "5969180000000450727",
      "noteOwner": "5969180000000438001",
      "noteTitle": null,
      "noteContent": "Spoke to him today. wants a call after 3 months",
      "noteContact": "5969180000000450247",
      "noteAccount": null,
      "noteOpportunity": null,
      "createdTimestamp": 1698286277,
      "updatedTimestamp": 1698286277,
      "id": "37d51915-cd88-4488-baf0-5b7379b01b42"
    },
    {
      "remoteId": "5969180000000450728",
      "noteOwner": "5969180000000438001",
      "noteTitle": null,
      "noteContent": "Prospect wanted to schedule call on Friday at 11:30 AM",
      "noteContact": "5969180000000450248",
      "noteAccount": null,
      "noteOpportunity": null,
      "createdTimestamp": 1698286277,
      "updatedTimestamp": 1698286277,
      "id": "b400ef12-9418-47d3-cd88-20da0f6b5bda"
    },
    {
      "remoteId": "5969180000000450729",
      "noteOwner": "5969180000000438001",
      "noteTitle": null,
      "noteContent": "Called the prospect. Need to schedule another call with his manager.",
      "noteContact": "5969180000000450249",
      "noteAccount": null,
      "noteOpportunity": null,
      "createdTimestamp": 1698286277,
      "updatedTimestamp": 1698286277,
      "id": "be8a490a-cd88-4b7f-b5b4-66f090817b24"
    },
    {
      "remoteId": "5969180000000450731",
      "noteOwner": "5969180000000438001",
      "noteTitle": null,
      "noteContent": "100 subscriptions deal. Details has been sent",
      "noteContact": "5969180000000450251",
      "noteAccount": null,
      "noteOpportunity": null,
      "createdTimestamp": 1698286277,
      "updatedTimestamp": 1698286277,
      "id": "e4587a40-0631-cd88-be45-63c4adaf2fee"
    }
  ],
  "pageInfo": {
    "hasNext": false,
    "nextCursor": null
  }
}

400

400

application/json

Schema

Schema

object

Example (from schema)

{}

Result

{}

Loading...