Copy
Ask AI
curl --request GET \
--url 'https://api.caret.so/v1/notes?limit=10&status=completed' \
--header 'X-API-Key: <your_api_key>'
Copy
Ask AI
{
"items": [
{
"id": "note_123456789",
"workspace_id": "ws_123456789",
"title": "Weekly Team Sync",
"status": "completed",
"created_at": "2024-01-28T10:00:00Z",
"audio_url": "https://cdn.caret.at/audio/...",
"total_duration_sec": 3600,
"calendarEvent": null,
"creator": {
"id": "user_123",
"name": "John Doe",
"email": "[email protected]"
}
}
],
"pagination": {
"limit": 10,
"nextOffset": 10,
"isLast": false
}
}
Notes
List Notes
Get a paginated list of notes with various filtering options
GET
/
v1
/
notes
Copy
Ask AI
curl --request GET \
--url 'https://api.caret.so/v1/notes?limit=10&status=completed' \
--header 'X-API-Key: <your_api_key>'
Copy
Ask AI
{
"items": [
{
"id": "note_123456789",
"workspace_id": "ws_123456789",
"title": "Weekly Team Sync",
"status": "completed",
"created_at": "2024-01-28T10:00:00Z",
"audio_url": "https://cdn.caret.at/audio/...",
"total_duration_sec": 3600,
"calendarEvent": null,
"creator": {
"id": "user_123",
"name": "John Doe",
"email": "[email protected]"
}
}
],
"pagination": {
"limit": 10,
"nextOffset": 10,
"isLast": false
}
}
Query Parameters
Number of notes to return (1-100)
Pagination offset
Field to sort by. Options:
createdAt, updatedAt, titleSort order. Options:
asc, descFilter by note status. Options:
idle, recording, postprocessing,
recorded-not-summarized, summarizing, completedSearch query for title
Filter by creator user ID
Filter notes created after date (ISO 8601 format)
Filter notes created before date (ISO 8601 format)
Comma-separated folder IDs to filter by
Deprecated: Use
folderIds instead. Comma-separated tag IDsResponse
Show Note
Show Note
Unique identifier for the note
Workspace ID the note belongs to
Title of the note
Current status of the note
ISO8601 timestamp when the note was created
URL to the audio recording
Total duration of the recording in seconds
Associated calendar event data
User who created the note
Copy
Ask AI
curl --request GET \
--url 'https://api.caret.so/v1/notes?limit=10&status=completed' \
--header 'X-API-Key: <your_api_key>'
Copy
Ask AI
{
"items": [
{
"id": "note_123456789",
"workspace_id": "ws_123456789",
"title": "Weekly Team Sync",
"status": "completed",
"created_at": "2024-01-28T10:00:00Z",
"audio_url": "https://cdn.caret.at/audio/...",
"total_duration_sec": 3600,
"calendarEvent": null,
"creator": {
"id": "user_123",
"name": "John Doe",
"email": "[email protected]"
}
}
],
"pagination": {
"limit": 10,
"nextOffset": 10,
"isLast": false
}
}
⌘I