Notes

The Notes API allows you to manage notes and AI-generated summaries within the Meridian CRM system.

Authentication

All requests must include a Bearer token in the HTTP header:

Authorization: Bearer ACCESS_TOKEN

Endpoints

List Notes

Description: Retrieve a list of notes from the user's organization.

Endpoint: GET api/public/v1/notes/

Optional Query Parameters:

search (string): Filter by note title or content
ordering (string): Order results by specific fields (e.g., created, modified for descending)
company (UUID): Filter by associated company
deal (UUID): Filter by associated deal
meeting (UUID): Filter by associated meeting

Response Example:

[
  {
    "id": "9c0d1e2f-3a4b-5c6d-7e8f-9a0b1c2d3e4f",
    "title": "Meeting Notes",
    "content": "<p>Key points discussed during the meeting...</p>",
    "created": "2025-05-15T11:15:00Z",
    "modified": "2025-05-15T11:30:00Z",
    "is_ai_generated": true,
    "meeting": {
      "id": "7e8f9a0b-1c2d-3e4f-5a6b-7c8d9e0f1a2b",
      "title": "Deal Discussion"
    },
    "company": {
      "id": "bfcd725e-88da-41cd-8d9c-6aed5dda1a4a",
      "title": "Acme Corp"
    },
    "deal": {
      "id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
      "title": "Enterprise Software License"
    },
    "user": {
      "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
      "first_name": "John",
      "last_name": "Doe"
    }
  }
]

Get Note Details

Description: Retrieve details for a specific note.

Endpoint: GET api/public/v1/notes/{id}/

Response Example:

{
  "id": "9c0d1e2f-3a4b-5c6d-7e8f-9a0b1c2d3e4f",
  "title": "Meeting Notes",
  "content": "<p>Key points discussed during the meeting...</p>",
  "created": "2025-05-15T11:15:00Z",
  "modified": "2025-05-15T11:30:00Z",
  "is_ai_generated": true,
  "ai_generation_status": "completed",
  "organization": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
  "meeting": {
    "id": "7e8f9a0b-1c2d-3e4f-5a6b-7c8d9e0f1a2b",
    "title": "Deal Discussion",
    "start_time": "2025-05-15T10:00:00Z",
    "end_time": "2025-05-15T11:00:00Z"
  },
  "company": {
    "id": "bfcd725e-88da-41cd-8d9c-6aed5dda1a4a",
    "title": "Acme Corp",
    "website": "<https://acme-corp.com/>"
  },
  "deal": {
    "id": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
    "title": "Enterprise Software License"
  },
  "user": {
    "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com"
  },
  "action_items": [
    {
      "id": "5e6f7a8b-9c0d-1e2f-3a4b-5c6d7e8f9a0b",
      "content": "Send follow-up proposal by Friday",
      "is_completed": false,
      "assigned_to": {
        "id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        "first_name": "John",
        "last_name": "Doe"
      }
    }
  ],
  "tags": [
    {
      "id": "7c8d9e0f-1a2b-3c4d-5e6f-7a8b9c0d1e2f",
      "name": "Important",
      "color": "#FF0000"
    }
  ]
}

Create Note

Description: Create a new note.

Endpoint: POST api/public/v1/notes/

Request Example:

{
  "title": "Client Feedback",
  "content": "<p>Client provided feedback on the latest proposal...</p>",
  "company": "bfcd725e-88da-41cd-8d9c-6aed5dda1a4a",
  "deal": "7a8b9c0d-1e2f-3a4b-5c6d-7e8f9a0b1c2d",
  "meeting": null,
  "is_ai_generated": false
}

Response: Returns the created note object with HTTP 201 status code.

Update Note

Description: Update an existing note.

Endpoint: PUT api/public/v1/notes/{id}/

Request Example:

{
  "title": "Updated Client Feedback",
  "content": "<p>Updated client feedback on the latest proposal...</p>"
}

Response: Returns the updated note object.

Delete Note

Description: Delete a note.

Endpoint: DELETE api/public/v1/notes/{id}/

Response: Returns HTTP 204 No Content on success.

Manage Action Items

Description: Add, update, or remove action items for a note.

Endpoint: POST api/public/v1/notes/action-items/

Request Example:

{
  "note": "9c0d1e2f-3a4b-5c6d-7e8f-9a0b1c2d3e4f",
  "content": "Send follow-up proposal by Friday",
  "assigned_to": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
}

Response: Returns the created action item object with HTTP 201 status code.

Endpoint: PUT api/public/v1/notes/action-items/{id}/

Request Example:

{
  "content": "Send updated follow-up proposal by Monday",
  "is_completed": true
}

Response: Returns the updated action item object.

Delete Endpoint: DELETE api/public/v1/notes/action-items/{id}/

Response: Returns HTTP 204 No Content on success.

Manage Tags

Description: Add, update, or remove tags for a note.

Endpoint: POST api/public/v1/notes/tags/

Request Example:

{
  "name": "Important",
  "color": "#FF0000"
}

Response: Returns the created attachment object with HTTP 201 status code.

Update Endpoint: PUT api/public/v1/notes/tags/{id}/

Request Example:

{
  "name": "Critical",
  "color": "#FF0000"
}

Response: Returns the updated tag object.

Delete Endpoint: DELETE api/public/v1/notes/tags/{id}/

Response: Returns HTTP 204 No Content on success.

Add Tag to Note

Description: Associate a tag with a note.

Endpoint: POST api/public/v1/notes/{note_id}/add-tag/{tag_id}/

Response: Returns HTTP 200 OK on success.

Remove Tag from Note

Description: Remove a tag association from a note.

Endpoint: DELETE api/public/v1/notes/{note_id}/remove-tag/{tag_id}/

Response: Returns HTTP 204 No Content on success.

Metadata Endpoints

Note Metadata

Description: Retrieve metadata about note fields, including field names, types, and whether they are required, createable, or updateable.

Endpoint: GET api/public/v1/notes/metadata/fields/

Request Example:

{
  "fields": [
    {
      "name": "title",
      "label": "Note Title",
      "type": "string",
      "required": true,
      "createable": true,
      "updateable": true
    },
    {
      "name": "content",
      "label": "Content",
      "type": "html",
      "required": true,
      "createable": true,
      "updateable": true
    },
    {
      "name": "is_ai_generated",
      "label": "AI Generated",
      "type": "boolean",
      "required": false,
      "createable": true,
      "updateable": false
    },
    {
      "name": "meeting",
      "label": "Meeting",
      "type": "reference",
      "reference_to": "meeting",
      "required": false,
      "createable": true,
      "updateable": true
    },
    {
      "name": "company",
      "label": "Company",
      "type": "reference",
      "reference_to": "company",
      "required": false,
      "createable": true,
      "updateable": true
    },
    {
      "name": "deal",
      "label": "Deal",
      "type": "reference",
      "reference_to": "deal",
      "required": false,
      "createable": true,
      "updateable": true
    }
  ]
}

Action Item Metadata

Description: Retrieve metadata about action item fields.

Endpoint: GET api/public/v1/notes/action-items/metadata/fields/

Request Example:

{
  "fields": [
    {
      "name": "note",
      "label": "Note",
      "type": "reference",
      "reference_to": "note",
      "required": true,
      "createable": true,
      "updateable": false
    },
    {
      "name": "content",
      "label": "Content",
      "type": "string",
      "required": true,
      "createable": true,
      "updateable": true
    },
    {
      "name": "is_completed",
      "label": "Completed",
      "type": "boolean",
      "required": false,
      "createable": true,
      "updateable": true
    },
    {
      "name": "assigned_to",
      "label": "Assigned To",
      "type": "reference",
      "reference_to": "user",
      "required": false,
      "createable": true,
      "updateable": true
    }
  ]
}

Tag Metadata

Description: Retrieve metadata about tag fields.

Endpoint: GET api/public/v1/notes/tags/metadata/fields/

Request Example:

{
  "fields": [
    {
      "name": "name",
      "label": "Name",
      "type": "string",
      "required": true,
      "createable": true,
      "updateable": true
    },
    {
      "name": "color",
      "label": "Color",
      "type": "string",
      "required": true,
      "createable": true,
      "updateable": true,
      "pattern": "^#[0-9A-Fa-f]{6}$"
    }
  ]
}

Error Responses

400 Bad Request: Invalid request parameters
401 Unauthorized: Missing or invalid authentication
403 Forbidden: Insufficient permissions
404 Not Found: Resource not found
500 Internal Server Error: Server-side error

Data Models

Note

Field

Type

Description

UUID

Unique identifier

title

String

Note title

content

String

Note content (HTML)

is_ai_generated

Boolean

Whether the note was generated by AI

ai_generation_status

String

Status of AI generation (pending/completed/failed)

organization

UUID

Reference to organization

meeting

UUID

Reference to associated meeting (optional)

company

UUID

Reference to associated company (optional)

deal

UUID

Reference to associated deal (optional)

user

UUID

Reference to user who created the note

created

DateTime

Creation timestamp

modified

DateTime

Last modification timestamp

Action Item

Field

Type

Description

UUID

Unique identifier

note

UUID

Reference to note

content

String

Action item description

is_completed

Boolean

Whether the action item is completed

assigned_to

UUID

Reference to user assigned to the action item

created

DateTime

Creation timestamp

modified

DateTime

Last modification timestamp

Tag

Field

Type

Description

UUID

Unique identifier

name

String

Tag name

color

String

Hex color code

organization

UUID

Reference to organization

created

DateTime

Creation timestamp

modified

DateTime

Last modification timestamp

Meetings

People

Notes

Authentication

Endpoints

List Notes

Get Note Details

Create Note

Update Note

Delete Note

Manage Action Items

Manage Tags

Add Tag to Note

Remove Tag from Note

Metadata Endpoints

Note Metadata

Action Item Metadata

Tag Metadata

Error Responses

Data Models

Note

Action Item

Tag

Discover how Meridian can streamline deal sourcing and enhance your decision-making