AFaffinity
Notes

Get Persons attached to a Note

Changed on

Returns directly attached persons for a given Note.

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

Request

  • Base URL
    https://api.affinity.co
  • URL
    https://api.affinity.co/v2/notes/{noteId}/attached-persons
  • Auth
    HTTP bearer

Path parameters

noteIdinteger required

The id of the Note to get attached Persons

Query parameters

totalCountboolean

Include total count of the collection in the pagination response

cursorstring

Cursor for the next or previous page

limitinteger

Number of items to include in the page

Response

OK

Example response

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

Changes

  • 187749f77548Revision changes
    • info

      added authentication authorization bad-request conflict method-not-allowed not-acceptable not-found not-implemented rate-limit server timeout unprocessable-entity unsupported-media-type validation discriminator mapping keys to the / response property for the response status

    • info

      added bad-request validation discriminator mapping keys to the / response property for the response status