notes

Operations about notes

Get all Notes

⚠️ This endpoint is currently in BETA

Returns all notes, with the exception of replies. You can filter notes using the filter query parameter. The filter parameter is a string that you can specify conditions based on the following properties.

Property Name	Description	Type	Allowed Operators	Examples
`id`	Filter notes by id	`int32`	`=`	`id=1`
`creator.id`	Filter notes by the creator of the note	`int32`	`=`	`creator.id=1`
`createdAt`	Filter notes by when it was created	`datetime`	`>`, `<`, `>=`, `<=`	`createdAt<2025-02-04T10:48:24Z`
`updatedAt`	Filter notes by when it was updated	`datetime`	`>`, `<`, `>=`, `<=`	`updatedAt>=2025-02-03T10:48:24Z`

SecuritybearerAuth

Request

query Parameters

totalCount	boolean Default: false Include total count of the collection in the pagination response
cursor	string Cursor for the next or previous page
limit	integer <int32> [ 0 .. 100 ] Default: 20 Number of items to include in the page
filter	string Filter options
includes	Array of strings (notes.includes) unique Additional properties to include in the response Items Enum: "companiesPreview" "personsPreview" "opportunitiesPreview" "repliesCount"

Responses

200

Response Headers
X-Ratelimit-Limit-User	integer Number of requests allowed per minute for the user
X-Ratelimit-Limit-User-Remaining	integer Number of requests remaining for the user
X-Ratelimit-Limit-User-Reset	integer Time in seconds before the limit resets for the user
X-Ratelimit-Limit-Org	integer Number of requests allowed per month for the account
X-Ratelimit-Limit-Org-Remaining	integer Number of requests remaining for the account
X-Ratelimit-Limit-Org-Reset	integer Time in seconds before the limit resets for the account

Response Schema: application/json

required

Array of any (notes.Note) <= 100 items

A page of Note objects

Array (<= 100 items)

type required	string The type of the note entities Value: "entities"
repliesCount	integer <int32> [ 0 .. 2147483647 ] The number of replies to this note. This is only included if the `repliesCount` parameter is passed in the `includes` in the request and the note is not a reply itself.
	object (notes.PermissionSettings) The permission settings of a note
	object (notes.OpportunitiesPreview) A preview for attached Opportunities on a Note
	object (notes.PersonsPreview) A preview for attached Persons on a Note
	object (notes.CompaniesPreview) A preview for attached Companies on a Note
id required	integer <int32> [ 1 .. 2147483647 ] The id of the note
required	object (notes.Content) A note content
required	object (PersonData)
required	Array of any (notes.Mention) <= 100 items The mentions in the note
createdAt required	string <date-time> The date and time the note was created
updatedAt required	string or null <date-time> The date and time the note was last updated

required

object (PaginationWithTotalCount)

totalCount	integer <int64> [ 0 .. 9007199254740991 ] The total count of the collection. Only included if requested via the totalCount query string parameter.
prevUrl	string or null <uri> URL for the previous page
nextUrl	string or null <uri> URL for the next page

400

Bad Request

404

Not Found

default

Errors

get/v2/notes

Request samples

curl
Node.js
Python
Ruby

Response samples

200
400
404
default

application/json

Example response for AI Notetaker notes.

{"data": [{"id": 1,
"type": "ai-notetaker",
"content": {"html": "<p> This is an AI Notetaker note! </p>"
},
"creator": {"id": 1,
"firstName": "Jane",
"lastName": "Doe",
"primaryEmailAddress": "jane.doe@acme.co",
"type": "internal"
},
"mentions": [ ],
"createdAt": "2023-01-01T00:00:00Z",
"updatedAt": "2023-01-21T00:00:00Z"
},
{"id": 2,
"type": "ai-notetaker",
"content": {"html": "<p> This is another AI Notetaker note! </p>"
},
"creator": {"id": 1,
"firstName": "Jane",
"lastName": "Doe",
"primaryEmailAddress": "jane.doe@acme.co",
"type": "internal"
},
"mentions": [ ],
"createdAt": "2024-01-01T00:00:00Z",
"updatedAt": "2024-01-21T00:00:00Z"
}
],
"pagination": {"prevUrl": "https://api.affinity.co/v2/notes?cursor=ICAgICAgYmVmb3JlOjo6Nw",
"nextUrl": "https://api.affinity.co/v2/notes?cursor=ICAgICAgIGFmdGVyOjo6NA"
}
}

Get a single Note

⚠️ This endpoint is currently in BETA

Get a Note with a given id

SecuritybearerAuth

Request

path Parameters

noteId

required

integer <int32> [ 1 .. 2147483647 ]

The id of the Note

query Parameters

includes

Array of strings (note.includes) unique

Additional properties to include in the response

Items Enum: "companiesPreview" "personsPreview" "opportunitiesPreview" "repliesCount"

Responses

200

Response Headers
X-Ratelimit-Limit-User	integer Number of requests allowed per minute for the user
X-Ratelimit-Limit-User-Remaining	integer Number of requests remaining for the user
X-Ratelimit-Limit-User-Reset	integer Time in seconds before the limit resets for the user
X-Ratelimit-Limit-Org	integer Number of requests allowed per month for the account
X-Ratelimit-Limit-Org-Remaining	integer Number of requests remaining for the account
X-Ratelimit-Limit-Org-Reset	integer Time in seconds before the limit resets for the account

Response Schema: application/json

type

required

string

The type of the note

Value: "entities"

repliesCount

integer <int32> [ 0 .. 2147483647 ]

The number of replies to this note. This is only included if the repliesCount parameter is passed in the includes in the request and the note is not a reply itself.

object (notes.PermissionSettings)

The permission settings of a note

sharingType required	string The sharing type of the note Enum: "private" "public" "custom"
required	object (PersonData)

object (notes.OpportunitiesPreview)

A preview for attached Opportunities on a Note

	Array of objects (Opportunity) <= 100 items Preview of attached Opportunities for a Note
totalCount	integer <int64> [ 0 .. 9007199254740991 ] The total count of the collection parameter.

object (notes.PersonsPreview)

A preview for attached Persons on a Note

	Array of objects (PersonData) <= 100 items Preview of attached Persons for a Note
totalCount	integer <int64> [ 0 .. 9007199254740991 ] The total count of the collection parameter.

object (notes.CompaniesPreview)

A preview for attached Companies on a Note

	Array of objects (CompanyData) <= 100 items Preview of attached Companies for a Note
totalCount	integer <int64> [ 0 .. 9007199254740991 ] The total count of the collection parameter.

required

integer <int32> [ 1 .. 2147483647 ]

The id of the note

required

object (notes.Content)

A note content

html

required

string or null

The HTML content of the note

required

object (PersonData)

id required	integer <int64> [ 1 .. 9007199254740991 ] The persons's unique identifier
firstName required	string or null The person's first name
lastName required	string or null The person's last name
primaryEmailAddress required	string or null <email> The person's primary email address
type required	string The person's type Enum: "internal" "external" "collaborator"

required

Array of any (notes.Mention) <= 100 items

The mentions in the note

Array (<= 100 items)

id required	integer <int32> [ 1 .. 2147483647 ] The id of the mention
type required	string The type of mention person Value: "person"
required	object (PersonData)

createdAt

required

string <date-time>

The date and time the note was created

updatedAt

required

string or null <date-time>

The date and time the note was last updated

400

Bad Request

404

Not Found

default

Errors

get/v2/notes/{noteId}

Request samples

curl
Node.js
Python
Ruby

Response samples

200
400
404
default

application/json

Example response for an AI Notetaker note.

{"id": 1,
"type": "ai-notetaker",
"content": {"html": "<p> This is an AI Notetaker note! </p>"
},
"creator": {"id": 1,
"firstName": "Jane",
"lastName": "Doe",
"primaryEmailAddress": "jane.doe@acme.co",
"type": "internal"
},
"mentions": [ ],
"createdAt": "2023-01-01T00:00:00Z",
"updatedAt": "2023-01-21T00:00:00Z"
}

Get Companies attached to a Note

⚠️ This endpoint is currently in BETA

Returns directly attached companies for a given Note.

SecuritybearerAuth

Request

path Parameters

noteId

required

integer <int32> [ 1 .. 2147483647 ]

The id of the Note to get attached Companies

query Parameters

totalCount	boolean Default: false Include total count of the collection in the pagination response
cursor	string Cursor for the next or previous page
limit	integer <int32> [ 0 .. 100 ] Default: 20 Number of items to include in the page

Responses

200

Response Headers
X-Ratelimit-Limit-User	integer Number of requests allowed per minute for the user
X-Ratelimit-Limit-User-Remaining	integer Number of requests remaining for the user
X-Ratelimit-Limit-User-Reset	integer Time in seconds before the limit resets for the user
X-Ratelimit-Limit-Org	integer Number of requests allowed per month for the account
X-Ratelimit-Limit-Org-Remaining	integer Number of requests remaining for the account
X-Ratelimit-Limit-Org-Reset	integer Time in seconds before the limit resets for the account

Response Schema: application/json

required

Array of objects (CompanyData) <= 100 items

A page of Company results

Array (<= 100 items)

id required	integer <int64> [ 1 .. 9007199254740991 ] The company's unique identifier
name required	string The company's name
domain required	string or null <hostname> The company's primary domain

required

object (Pagination)

prevUrl	string or null <uri> URL for the previous page
nextUrl	string or null <uri> URL for the next page

400

Bad Request

404

Not Found

default

Errors

get/v2/notes/{noteId}/attached-companies

Request samples

curl
Node.js
Python
Ruby

Response samples

200
400
404
default

application/json

{"pagination": {"prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
"nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
},
"data": [{"domain": "acme.co",
"name": "Acme",
"id": 1
},
{"domain": "acme.co",
"name": "Acme",
"id": 1
}
]
}

Get Opportunities attached to a Note

⚠️ This endpoint is currently in BETA

Returns directly attached opportunities for a given Note.

SecuritybearerAuth

Request

path Parameters

noteId

required

integer <int32> [ 1 .. 2147483647 ]

The id of the Note to get attached Opportunities

query Parameters

totalCount	boolean Default: false Include total count of the collection in the pagination response
cursor	string Cursor for the next or previous page
limit	integer <int32> [ 0 .. 100 ] Default: 20 Number of items to include in the page

Responses

200

Response Headers
X-Ratelimit-Limit-User	integer Number of requests allowed per minute for the user
X-Ratelimit-Limit-User-Remaining	integer Number of requests remaining for the user
X-Ratelimit-Limit-User-Reset	integer Time in seconds before the limit resets for the user
X-Ratelimit-Limit-Org	integer Number of requests allowed per month for the account
X-Ratelimit-Limit-Org-Remaining	integer Number of requests remaining for the account
X-Ratelimit-Limit-Org-Reset	integer Time in seconds before the limit resets for the account

Response Schema: application/json

required

Array of objects (Opportunity) <= 100 items

A page of Opportunity results

Array (<= 100 items)

id required	integer <int64> [ 1 .. 9007199254740991 ] The unique identifier for the opportunity
name required	string The name of the opportunity
listId required	integer <int64> [ 1 .. 9007199254740991 ] The ID of the list that the opportunity belongs to

required

object (Pagination)

prevUrl	string or null <uri> URL for the previous page
nextUrl	string or null <uri> URL for the next page

400

Bad Request

404

Not Found

default

Errors

get/v2/notes/{noteId}/attached-opportunities

Request samples

curl
Node.js
Python
Ruby

Response samples

200
400
404
default

application/json

Example response on fetching opportunities attached to a note.

{"data": [{"id": 1,
"name": "Opp Name",
"listId": 1000
},
{"id": 2,
"name": "Another Opp Name",
"listId": 1001
}
],
"pagination": {"prevUrl": "https://api.affinity.co/v2/notes/1/attached-opportunities?cursor=ICAgICAgYmVmb3JlOjo6Nw",
"nextUrl": "https://api.affinity.co/v2/notes/1/attached-opportunities?cursor=ICAgICAgIGFmdGVyOjo6NA"
}
}

Get Persons attached to a Note

⚠️ This endpoint is currently in BETA

Returns directly attached persons for a given Note.

SecuritybearerAuth

Request

path Parameters

noteId

required

integer <int32> [ 1 .. 2147483647 ]

The id of the Note to get attached Persons

query Parameters

totalCount	boolean Default: false Include total count of the collection in the pagination response
cursor	string Cursor for the next or previous page
limit	integer <int32> [ 0 .. 100 ] Default: 20 Number of items to include in the page

Responses

200

Response Headers
X-Ratelimit-Limit-User	integer Number of requests allowed per minute for the user
X-Ratelimit-Limit-User-Remaining	integer Number of requests remaining for the user
X-Ratelimit-Limit-User-Reset	integer Time in seconds before the limit resets for the user
X-Ratelimit-Limit-Org	integer Number of requests allowed per month for the account
X-Ratelimit-Limit-Org-Remaining	integer Number of requests remaining for the account
X-Ratelimit-Limit-Org-Reset	integer Time in seconds before the limit resets for the account

Response Schema: application/json

required

Array of objects (PersonData) <= 100 items

A page of Person results

Array (<= 100 items)

id required	integer <int64> [ 1 .. 9007199254740991 ] The persons's unique identifier
firstName required	string or null The person's first name
lastName required	string or null The person's last name
primaryEmailAddress required	string or null <email> The person's primary email address
type required	string The person's type Enum: "internal" "external" "collaborator"

required

object (Pagination)

prevUrl	string or null <uri> URL for the previous page
nextUrl	string or null <uri> URL for the next page

400

Bad Request

404

Not Found

default

Errors

get/v2/notes/{noteId}/attached-persons

Request samples

curl
Node.js
Python
Ruby

Response samples

200
400
404
default

application/json

{"pagination": {"prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
"nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
},
"data": [{"firstName": "Jane",
"lastName": "Doe",
"id": 1,
"type": "internal",
"primaryEmailAddress": "jane.doe@acme.co"
},
{"firstName": "Jane",
"lastName": "Doe",
"id": 1,
"type": "internal",
"primaryEmailAddress": "jane.doe@acme.co"
}
]
}

Get replies for a Note

⚠️ This endpoint is currently in BETA

This endpoint returns reply notes for a given note id. You can filter replies using the filter query parameter. The filter parameter is a string that you can specify conditions based on the following properties.

Property Name	Description	Type	Allowed Operators	Examples
`creator.id`	Filter notes by the creator of the note	`int32`	`=`	`creator.id=1`
`createdAt`	Filter notes by when it was created	`datetime`	`>`, `<`, `>=`, `<=`	`createdAt<2025-02-04T10:48:24Z`
`updatedAt`	Filter notes by when it was updated	`datetime`	`>`, `<`, `>=`, `<=`	`updatedAt>=2025-02-03T10:48:24Z`

SecuritybearerAuth

Request

path Parameters

noteId

required

integer <int32> [ 1 .. 2147483647 ]

Note ID

query Parameters

filter	string Filter options
cursor	string Cursor for the next or previous page
limit	integer <int32> [ 0 .. 100 ] Default: 20 Number of items to include in the page
totalCount	boolean Default: false Include total count of the collection in the pagination response

Responses

200

Response Headers
X-Ratelimit-Limit-User	integer Number of requests allowed per minute for the user
X-Ratelimit-Limit-User-Remaining	integer Number of requests remaining for the user
X-Ratelimit-Limit-User-Reset	integer Time in seconds before the limit resets for the user
X-Ratelimit-Limit-Org	integer Number of requests allowed per month for the account
X-Ratelimit-Limit-Org-Remaining	integer Number of requests remaining for the account
X-Ratelimit-Limit-Org-Reset	integer Time in seconds before the limit resets for the account

Response Schema: application/json

required

Array of any (notes.Reply) <= 100 items

A page of Note Replies

Array (<= 100 items)

type required	string The type of the note user-reply Value: "user-reply"
required	object
id required	integer <int32> [ 1 .. 2147483647 ] The id of the note
required	object (notes.Content) A note content
required	object (PersonData)
required	Array of any (notes.Mention) <= 100 items The mentions in the note
createdAt required	string <date-time> The date and time the note was created
updatedAt required	string or null <date-time> The date and time the note was last updated

required

object (PaginationWithTotalCount)

totalCount	integer <int64> [ 0 .. 9007199254740991 ] The total count of the collection. Only included if requested via the totalCount query string parameter.
prevUrl	string or null <uri> URL for the previous page
nextUrl	string or null <uri> URL for the next page

400

Bad Request

404

Not Found

default

Errors

get/v2/notes/{noteId}/replies

Request samples

curl
Node.js
Python
Ruby

Response samples

200
400
404
default

application/json

{"data": [{"id": 2,
"type": "user-reply",
"content": {"html": "<p> This is a user reply note. <span data-type=\"note-mention\" data-note-mention-type=\"person\" data-note-mention-person-id=\"1\"> John Doe </span> was mentioned. </p>"
},
"creator": {"id": 1,
"firstName": "Jane",
"lastName": "Doe",
"primaryEmailAddress": "jane.doe@acme.co",
"type": "internal"
},
"mentions": [{"id": 1,
"type": "person",
"person": {"id": 1,
"firstName": "John",
"lastName": "Doe",
"primaryEmailAddress": "john.doe@acme.co",
"type": "internal"
}
}
],
"parent": {"id": 1
},
"createdAt": "2023-01-01T00:00:00Z",
"updatedAt": "2023-02-01T00:00:00Z"
}
],
"pagination": {"prevUrl": "https://api.affinity.co/v2/notes/1/replies?cursor=ICAgICAgYmVmb3JlOjo6Nw",
"nextUrl": "https://api.affinity.co/v2/notes/1/notes?cursor=ICAgICAgIGFmdGVyOjo6NA"
}
}

➔ Next to opportunities