List Notes - Caret

curl --request GET \
 --url 'https://api.caret.so/v1/notes?limit=10&status=completed' \
 --header 'X-API-Key: <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
  }
}

GET

notes

curl --request GET \
 --url 'https://api.caret.so/v1/notes?limit=10&status=completed' \
 --header 'X-API-Key: <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
  }
}

Query Parameters

limit

number

default:"20"

Number of notes to return (1-100)

offset

number

default:"0"

Pagination offset

sortBy

string

default:"createdAt"

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

sortOrder

string

default:"desc"

Sort order. Options: asc, desc

status

string

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

kind

string

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

string

Search query for title

createdBy

string

Filter by creator user ID

fromDate

string

Filter notes created after date (ISO 8601 format)

toDate

string

Filter notes created before date (ISO 8601 format)

folderIds

string

Comma-separated folder IDs to filter by

tagIds

string

deprecated

Deprecated: Use folderIds instead. Comma-separated tag IDs

participantEmail

string

Filter by participant email address

Response

items

Note[]

Show Note

string

Unique identifier for the note

title

string

Title of the note

kind

string

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

status

string

Current status of the note

createdAt

string

ISO8601 timestamp when the note was created

updatedAt

string

ISO8601 timestamp when the note was last updated

visibility

string

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

tags

object[]

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

Show Tag

string

Tag ID

name

string

Tag name

color

string

Tag color

participants

object[]

Participants from the calendar event

Show Participant

name

string

Participant name

string

Participant email

profileImageUrl

string

Profile image URL

accountName

string

Company name

accountDomain

string

Company domain

accountImageUrl

string

Company logo URL

totalDurationSec

number

Total duration of the recording in seconds

userWrittenNote

string

User-written note content

enhancedNote

string

AI-enhanced note content (empty in list response)

summary

string

Meeting summary content (empty in list response)

transcripts

object[]

Transcript segments (empty in list response)

calendarEvent

object | null

Associated calendar event data

Show CalendarEvent

string

Event ID

href

string

Event URL

title

string

Event title

startsAt

string

Start time (ISO8601)

endsAt

string

End time (ISO8601)

createdAt

string

Created time (ISO8601)

updatedAt

string

Updated time (ISO8601)

calendarId

string

Calendar ID

attendees

object[]

List of attendees

Show Attendee

self

boolean

Whether this is the authenticated user

string

Attendee email

displayName

string

Attendee display name

inputLanguage

string | null

Language of the audio input

translationLanguage

string | null

Translation target language (if applicable)

meetingApp

string | null

App used to auto-start the meeting

pagination

object

Show Pagination

limit

number

Number of items per page

nextOffset

number | null

Offset for the next page, null if last page

isLast

boolean

Whether this is the last page

curl --request GET \
 --url 'https://api.caret.so/v1/notes?limit=10&status=completed' \
 --header 'X-API-Key: <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
  }
}

Get Note

Update Note

⌘I

API Reference

​Query Parameters

​Response

Query Parameters

Response