Skip to main content
GET
/
v2
/
notes
List notes for a person or company
curl --request GET \
  --url https://client-api.salesfinity.co/v2/notes \
  --header 'x-api-key: <api-key>'
{
  "contact_id": "507f1f77bcf86cd799439011",
  "company_id": "507f1f77bcf86cd799439012",
  "notes": [
    {
      "_id": "507f1f77bcf86cd799439011",
      "team": "507f1f77bcf86cd799439012",
      "author": {
        "_id": "507f1f77bcf86cd799439011",
        "first_name": "<string>",
        "last_name": "<string>",
        "email": "<string>",
        "image": "<string>"
      },
      "content": "<string>",
      "is_pinned": true,
      "pinned_at": "2023-11-07T05:31:56Z",
      "pinned_by": "<string>",
      "contact": "<string>",
      "company": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.salesfinity.ai/llms.txt

Use this file to discover all available pages before exploring further.

Returns the notes attached to a person (Contact) or a company (Company), resolved from the identifiers you provide. This is resolve-only: unlike Create a Note, it never creates a record. If no matching person or company exists, it returns 404. Notes come back sorted pinned first, then by createdAt descending.

​
Query Parameters

ParameterTypeRequiredDescription
typestringYesperson or company. Determines which identifier params are required.

​
Person identifiers (type=person)

Supply at least one of linkedin_url, email, crm_id, or phone.
ParameterTypeDescription
linkedin_urlstringLinkedIn profile URL
emailstringEmail address
crm_idstringExternal CRM identifier
phonestringPhone number in E.164 format

​
Company identifiers (type=company)

Supply at least one of website_url or name.
ParameterTypeDescription
website_urlstringCompany website URL
namestringCompany name (case-insensitive)

​
Response

FieldTypeDescription
typestringTarget type echoed from the request (person or company).
contact_idstring | nullResolved unified Contact ID. Present when type=person. Stable across reimports and dialer drains.
company_idstring | nullResolved unified Company ID. Present when type=company.
notesarrayArray of note objects, pinned first then by creation date descending.

​
Note Object

FieldTypeDescription
_idstringNote ID
teamstringTeam that owns the note
authorobjectAuthor (_id, first_name, last_name, email, image). Populated when available; otherwise just _id.
contentstringPlain text content of the note
is_pinnedbooleanWhether the note is pinned to the top
pinned_atstring | nullWhen the note was pinned (ISO 8601)
pinned_bystring | nullID of the member who pinned it
contactstring | nullContact this note is attached to (mutually exclusive with company)
companystring | nullCompany this note is attached to (mutually exclusive with contact)
createdAtstringCreation timestamp (ISO 8601)
updatedAtstringLast update timestamp (ISO 8601)

​
Example Request

GET /v2/notes?type=person&email=[email protected]

​
Errors

StatusDescription
404No matching person or company found

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
type
enum<string>
required

Target type. Determines which identifier fields are required.

Available options:
person,
company
​
linkedin_url
string

LinkedIn profile URL (person only)

​
email
string

Email address (person only)

​
crm_id
string

External CRM identifier (person only)

​
phone
string

Phone number in E.164 format (person only)

​
website_url
string

Company website URL (company only)

​
name
string

Company name (company only)

Response

Notes retrieved successfully

​
type
enum<string>

Target type echoed from the request

Available options:
person,
company
​
contact_id
string | null

Resolved unified Contact ID (present when type=person). Stable across reimports and dialer drains.

Example:

"507f1f77bcf86cd799439011"

​
company_id
string | null

Resolved unified Company ID (present when type=company).

Example:

"507f1f77bcf86cd799439012"

​
notes
object[]

Notes attached to the resolved target, pinned first then by creation date descending