Notes
Supported note attributes:
| Attribute | Type | Description |
|---|---|---|
id |
number | Unique identifier of the note. |
creator_id |
number | Unique identifier of the user that created the note. |
content |
string | Content of the note. |
resource_id |
number | Unique identifier of the resource the note is attached to. |
resource_type |
string | Type name of the resource the note is attached to. |
type |
string | Type name of the note. Currently, onlyregulartype is supported. |
created_at |
string | Date and time that the note was created in UTC (ISO8601 format). |
Endpoints
Stream Notes
Read the stream of note events.
See theFirehose Overviewarticle for more details on request and response formats and parameters.
Action
GET /v3/notes/stream
Examples
Read the stream of note events
GET /v3/notes/stream?position=tailAccept: application/jsonAuthorization: Bearer $ACCESS_TOKENUser-Agent: $CLIENT_NAME
HTTP/1.1200OKContent-Type:application/json{"items":[{"data":{"creator_id":113859,"resource_type":"lead","resource_id":254952976,"created_at":"2017-11-02T15:35:45Z","id":2375991,"content":"note content","type":"regular"},"meta":{"event_cause":"interaction","sequence":1,"event_id":"Q95oKH8bQeav91O8ma9NvQ","event_type":"created","type":"note","event_time":"2017-11-02T15:35:45Z"}}],"meta":{"links":{"next":“https://api.getbase.com/v3/notes/stream?position=ZmlyZWhvc2UuZmFjdG9pZC5jb250YWN0LnNuYXBzaG90cywxLDMwNTQ5Mg=="},"position":"ZmlyZWhvc2UuZmFjdG9pZC5jb250YWN0LnNuYXBzaG90cywxLDMwNTQ5Mg==","top":false}}