Link Search Menu Expand Document

Updated Thu Sep 23rd 2021, 14:29 UTC

Index

GET /contacts/:contact/notes

A Contact Note is a note that can be written about a specific contact.

Examples

List Notes for a Contact

Request

GET /contacts/DQeeO69/notes
Example
$ curl -i -H Accept:"application/vnd.textus+jsonld" \
    -H Authorization:"Bearer {token}" \
    -X GET /contacts/DQeeO69/notes
    

Response

Status

200

Response Type

hydra:Collection

Example
{
  "@type": "hydra:Collection",
  "id": "/contacts/DQeeO69/notes",
  "@context": "/contexts/hydra:Collection.jsonld",
  "totalItems": 1,
  "members": [
    {
      "@type": "ContactNote",
      "id": "/contact_notes/RN5QNG",
      "@context": "/contexts/ContactNote.jsonld",
      "content": "Life is a fragile thing, Har. One minute you're chewin' on a burger, the next minute you're dead meat.",
      "createdAt": "2018-10-31T16:17:10.914Z",
      "updatedAt": "2018-10-31T16:17:10.914Z",
      "user": {
        "@type": "User",
        "@context": "/contexts/User.jsonld",
        "id": "/users/wqyODPA",
        "name": "Chuck Norris",
        "firstName": "Chuck",
        "lastName": "Norris",
        "email": "chuck@textus.example",
        "avatar": null,
        "automatedActor": false,
        "hasPassword": false,
        "discarded": false,
        "settings": {
          "notifications": {
            "email": true
          },
          "customSettings": {}
        },
        "memberships": "/users/wqyODPA/memberships"
      },
      "contact": "/contacts/DQeeO69"
    }
  ]
}

Table of contents


© 2021 TextUs