Skip to main content
GET
/
v2
/
notes
/
{noteId}
/
attached-persons
Get Persons attached to a Note
curl --request GET \
  --url https://api.affinity.co/v2/notes/{noteId}/attached-persons \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 4503599627370496,
      "firstName": "<string>",
      "lastName": "<string>",
      "primaryEmailAddress": "[email protected]",
      "type": "internal"
    }
  ],
  "pagination": {
    "prevUrl": "<string>",
    "nextUrl": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
noteId
integer<int32>
required

The id of the Note to get attached Persons

Required range: 1 <= x <= 2147483647

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>
default:20

Number of items to include in the page

Required range: 0 <= x <= 100

Response

OK

PersonDataPaged model

​
data
PersonData · object[]
required

A page of Person results

Maximum array length: 100
​
pagination
Pagination · object
required
Example:
{
  "prevUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgYmVmb3JlOjo6Nw",
  "nextUrl": "https://api.affinity.co/v2/foo?cursor=ICAgICAgIGFmdGVyOjo6NA"
}