API | Notes Endpoints

The Tripleseat Open API allows you to create, retrieve, update, and delete notes on supported objects.

Notes are always associated with a parent object and are accessed via nested endpoints.

Authentication

All Notes endpoints require OAuth2 Bearer Token authentication.

Authorization: Bearer YOUR_ACCESS_TOKEN

Supported Parent Endpoints

1. List Notes

GET /v1/{parent}/{id}/notes

Returns a paginated list of notes for the specified parent object.

Optional Query Parameters

Example

GET /v1/events/123/notes?page=1&per_page=50
Authorization: Bearer YOUR_ACCESS_TOKEN

2. Retrieve a Single Note 

GET /v1/{parent}/{id}/notes/{note_id}

Returns a specific note associated with the parent object.

GET /v1/bookings/456/notes/789
Authorization: Bearer YOUR_ACCESS_TOKEN

3. Create a Note

POST /v1/{parent}/{id}/notes

Request Body

{
  "note": {
    "body": "Note text goes here",
    "created_by": 123
  }
}

Accepted Fields

Example

POST /v1/accounts/100/notes
Authorization: Bearer YOUR_ACCESS_TOKEN
Content-Type: application/json

{
  "note": {
    "body": "Client requested contract revision.",
    "created_by": 5
  }
}

4. Update a Note

PUT /v1/{parent}/{id}/notes/{note_id}

Request Body

{
  "note": {
    "body": "Updated note text",
    "created_by": 123
  }
}

5. Delete a Note

DELETE /v1/{parent}/{id}/notes/{note_id}

Deletes a note associated with the parent object.

Successful responses:

• 204 No Content (most endpoints)
• 200 OK (varies by parent object)

Important: Deleted notes are not retrievable via the API after deletion.

Note Object Schema

Error Handling

401 – Unauthorized

• Token missing
• Token invalid
• Token expired

404 – Not Found

• Parent object does not exist
• Note does not exist

422 – Unprocessable Entity

• body is missing
• Invalid payload structure