Notes Endpoint
Here you will information on how to interact with the Notes Endpoint including available endpoint actions, fields, and expands.
Endpoint Actions
Create Record
POST /v2/notes
Update Record
PUT /v2/notes/{id}
View Single Record
GET /v2/notes/{id}
View Record List
GET /v2/notes
Note: Filters can be used to search for Notes by including the columns you want to filter on as URL parameters. i.e. /v2/notes?field=value&field2=value2
Delete Record
DELETE /v2/notes/{id}
Fields
Name | Format | Min. | Max. | Allowed on POST (Create) | Allowed on PUT (Update) | Default |
---|---|---|---|---|---|---|
id | string | 36 | System Generated | System Generated | ||
created_ts | integer | 10 | System Generated | System Generated | ||
resource_id | string | 36 | System Generated | System Generated | ||
resource | string | |||||
modified_ts | integer | 10 | System Generated | System Generated | ||
note | string | 16384 | Default | |||
visibility_group_id | string |
Expands (Related Records)
For detail on how to use Expands on an Endpoint, please visit the Expands (Related Records) page.
Related Record | Filter Name |
---|---|
Created User | created_user |
Visibility Group | visibility_group |
An example of “expanding” this endpoint to one of the above related records would look like this:
GET /v2/notes/xxxxxxxxxxxxxxxxxxxxxxxx?expand=created_user
To use multiple expands on this endpoint, simply include them both separated by a comma like so:
GET /v2/notes/xxxxxxxxxxxxxxxxxxxxxxxx?expand=created_user,visibility_group