List Notes - Caret

curl --request GET \
 --url 'https://api.caret.so/v1/notes?limit=10&status=completed' \
 --header 'Authorization: Bearer <your_api_key>'

{
  "items": [
    {
      "id": "note_123456789",
      "title": "Weekly Team Sync",
      "kind": "online",
      "status": "completed",
      "createdAt": "2024-01-28T10:00:00Z",
      "updatedAt": "2024-01-28T11:30:00Z",
      "visibility": "workspace",
      "tags": [
        {
          "id": "fld_123",
          "name": "Sales",
          "color": "#4A90E2"
        }
      ],
      "participants": [
        {
          "name": "Jane Smith",
          "email": "jane@example.com",
          "profileImageUrl": "https://example.com/avatar.jpg",
          "accountName": "Acme Corp",
          "accountDomain": "acme.com",
          "accountImageUrl": "https://example.com/logo.png"
        }
      ],
      "totalDurationSec": 3600,
      "userWrittenNote": "",
      "enhancedNote": "",
      "summary": "",
      "transcripts": [],
      "calendarEvent": null,
      "inputLanguage": "en",
      "translationLanguage": null,
      "meetingApp": null
    }
  ],
  "pagination": {
    "limit": 10,
    "nextOffset": 10,
    "isLast": false
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key"
  }
}

GET

notes

curl --request GET \
 --url 'https://api.caret.so/v1/notes?limit=10&status=completed' \
 --header 'Authorization: Bearer <your_api_key>'

{
  "items": [
    {
      "id": "note_123456789",
      "title": "Weekly Team Sync",
      "kind": "online",
      "status": "completed",
      "createdAt": "2024-01-28T10:00:00Z",
      "updatedAt": "2024-01-28T11:30:00Z",
      "visibility": "workspace",
      "tags": [
        {
          "id": "fld_123",
          "name": "Sales",
          "color": "#4A90E2"
        }
      ],
      "participants": [
        {
          "name": "Jane Smith",
          "email": "jane@example.com",
          "profileImageUrl": "https://example.com/avatar.jpg",
          "accountName": "Acme Corp",
          "accountDomain": "acme.com",
          "accountImageUrl": "https://example.com/logo.png"
        }
      ],
      "totalDurationSec": 3600,
      "userWrittenNote": "",
      "enhancedNote": "",
      "summary": "",
      "transcripts": [],
      "calendarEvent": null,
      "inputLanguage": "en",
      "translationLanguage": null,
      "meetingApp": null
    }
  ],
  "pagination": {
    "limit": 10,
    "nextOffset": 10,
    "isLast": false
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key"
  }
}

Query Parameters

number

default:"20"

Number of notes to return (1-100)

number

default:"0"

Pagination offset

string

default:"createdAt"

Field to sort by. Options: createdAt, updatedAt, title

string

default:"desc"

Sort order. Options: asc, desc

string

Filter by note status. Options: idle, recording, transcript-processing, recorded-not-summarized, summarizing, completed

string

Filter by note kind. Options: online, in-person, podcast (currently only online is supported)

string

Search query for title

string

Filter by creator user ID

string

Filter notes created after date (ISO 8601 format)

string

Filter notes created before date (ISO 8601 format)

string

Comma-separated folder IDs to filter by

string

deprecated

Deprecated: Use folderIds instead. Comma-separated tag IDs

string

Filter by participant email address

Response

Note[]

Show Note

string

Unique identifier for the note

string

Title of the note

string

Type of the note. One of online, in-person, podcast

string

Current status of the note

string

ISO8601 timestamp when the note was created

string

ISO8601 timestamp when the note was last updated

string

Visibility setting. One of only-me, workspace, public

object[]

Folders associated with the note (returned as tags for compatibility)

Show Tag

string

Tag ID

string

Tag name

string

Tag color

object[]

Participants from the calendar event

Show Participant

string

Participant name

string

Participant email

string

Profile image URL

string

Company name

string

Company domain

string

Company logo URL

number

Total duration of the recording in seconds

string

User-written note content

string

AI-enhanced note content (empty in list response)

string

Meeting summary content (empty in list response)

object[]

Transcript segments (empty in list response)

object | null

Associated calendar event data

Show CalendarEvent

string

Event ID

string

Event URL

string

Event title

string

Start time (ISO8601)

string

End time (ISO8601)

string

Created time (ISO8601)

string

Updated time (ISO8601)

string

Calendar ID

object[]

List of attendees

Show Attendee

boolean

Whether this is the authenticated user

string

Attendee email

string

Attendee display name

string | null

Language of the audio input

string | null

Translation target language (if applicable)

string | null

App used to auto-start the meeting

object

Show Pagination

number

Number of items per page

number | null

Offset for the next page, null if last page

boolean

Whether this is the last page

curl --request GET \
 --url 'https://api.caret.so/v1/notes?limit=10&status=completed' \
 --header 'Authorization: Bearer <your_api_key>'

{
  "items": [
    {
      "id": "note_123456789",
      "title": "Weekly Team Sync",
      "kind": "online",
      "status": "completed",
      "createdAt": "2024-01-28T10:00:00Z",
      "updatedAt": "2024-01-28T11:30:00Z",
      "visibility": "workspace",
      "tags": [
        {
          "id": "fld_123",
          "name": "Sales",
          "color": "#4A90E2"
        }
      ],
      "participants": [
        {
          "name": "Jane Smith",
          "email": "jane@example.com",
          "profileImageUrl": "https://example.com/avatar.jpg",
          "accountName": "Acme Corp",
          "accountDomain": "acme.com",
          "accountImageUrl": "https://example.com/logo.png"
        }
      ],
      "totalDurationSec": 3600,
      "userWrittenNote": "",
      "enhancedNote": "",
      "summary": "",
      "transcripts": [],
      "calendarEvent": null,
      "inputLanguage": "en",
      "translationLanguage": null,
      "meetingApp": null
    }
  ],
  "pagination": {
    "limit": 10,
    "nextOffset": 10,
    "isLast": false
  }
}

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key"
  }
}

⌘I

​Query Parameters

​Response

Query Parameters

Response