Retrieve a note

Returns one note by its id, drafts included. As with GET /notes, only notes the caller is allowed to see can be read: notes on activity entries are always shown. Notes on contacts need permission to edit contacts (pg_subscriber_edit), notes on deals need deal access (pg_deal) and an account with Deals, notes on deal tasks need permission to see all deals (pg_deal_list_all), and notes on accounts need permission to edit accounts (pg_account_edit). Any other note returns 404, the same as an unknown id.

{
    "note": {
        "relid": "2",
        "reltype": "Subscriber",
        "userid": "1",
        "cdate": "2018-09-12T17:20:20-05:00",
        "mdate": "2018-09-20T09:10:06-05:00",
        "note": "TEST NOTE",
        "links": {
            "activities": "https://:account.api-us1.com/api/:version/notes/2/activities",
            "user": "https://:account.api-us1.com/api/:version/notes/2/user",
            "mentions": "https://:account.api-us1.com/api/:version/notes/2/mentions",
            "notes": "https://:account.api-us1.com/api/:version/notes/2/notes",
            "owner": "https://:account.api-us1.com/api/:version/notes/2/owner"
        },
        "id": "2",
        "user": "1",
        "owner": {
            "type": "contact",
            "id": "2"
        }
    }
}
Path Params
string
required

ID of the note to retrieve

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json