v1

latestOpenAPI 3.1.02026-07-247601.0 MB

Miscellaneous

Get a List of Notes

This endpoint doesn't consume Apollo credits. Learn more about API pricing and credits.

<a href="https://knowledge.apollo.io/hc/en-us/articles/28746467476365-Notes-Overview" target="_blank">Notes</a> on Apollo let you keep track of info directly on prospect profiles. The Get a List of Notes endpoint retrieves notes associated with a specific contact, account, opportunity, calendar event, or conversation in your Apollo account. You must provide at least one relation parameter (<code>account_id</code>, <code>contact_id</code>, <code>contact_ids</code>, <code>opportunity_id</code>, <code>calendar_event_id</code>, <code>conversation_id</code>, or <code>conversation_ids</code>). Use this endpoint to fetch notes with sorting and pagination support.

get/notes

Query parameters

contact_idstring

The ID of the contact whose notes you want to retrieve. Example: 60a5c0b8e4b0c7001c4f1234

account_idstring

The ID of the account whose notes you want to retrieve. Example: 60a5c0b8e4b0c7001c4f5678

opportunity_idstring

The ID of the opportunity whose notes you want to retrieve. Example: 60a5c0b8e4b0c7001c4f9012

calendar_event_idstring

The ID of the calendar event whose notes you want to retrieve. Example: 60a5c0b8e4b0c7001c4f3456

conversation_idstring

The ID of the conversation whose notes you want to retrieve. Example: 60a5c0b8e4b0c7001c4f7890

conversation_idsstring[]

An array of conversation IDs to filter notes by multiple conversations.

contact_idsstring[]

An array of contact IDs to filter notes by multiple contacts.

start_datestring

Filter notes created on or after this date. Must be a valid date string. Example: 2024-01-01

sort_by_field'created_at' | 'updated_at'

The field to sort results by. Defaults to created_at.

sort_direction'asc' | 'desc'

The direction to sort results. Defaults to desc.

skipinteger

The number of notes to skip for pagination. Must be a non-negative integer. Defaults to 0.

limitinteger

The maximum number of notes to return per request. Defaults to 25. Maximum value is 100.

Response

200

Example response

{
  "notes": [
    {
      "id": "60a5c0b8e4b0c7001c4fabcd",
      "user_id": "60a5c0b8e4b0c7001c4f0001",
      "content": "Had a productive call with the client.",
      "updated_at": "2024-06-15T14:30:00.000Z",
      "created_at": "2024-06-15T14:30:00.000Z",
      "contact_id": "60a5c0b8e4b0c7001c4f1234",
      "account_id": "60a5c0b8e4b0c7001c4f5678"
    }
  ]
}