Skip to main content
Retrieve a paginated list of notes with various filtering options.

​
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, recorded-not-summarized, summarizing, transcript-processing, completed
​
kind
string
Filter by note kind. Options: online, in-person, podcast
​
search
string
Search query for title or content
​
createdBy
string
Filter by creator user ID
​
fromDate
string
Filter notes created after date (ISO 8601)
​
toDate
string
Filter notes created before date (ISO 8601)
​
tagIds
string
Filter by comma-separated tag IDs
​
participantEmail
string
Filter by participant email

​
Response

​
items
array
List of notes
​
pagination
object
Pagination metadata

​
Example Request

curl -X GET 'https://api.caret.so/v1/notes?limit=10&offset=0&sortBy=createdAt&sortOrder=desc' \
  -H 'Authorization: Bearer {api_key}'

​
Example Response

{
  "items": [
    {
      "id": "01887270-12d4-7da0-b95c-9a9e9ebc3b13",
      "title": "Meeting with Acme Corp",
      "kind": "online",
      "status": "completed",
      "createdAt": "2023-08-01T15:30:00Z",
      "updatedAt": "2023-08-01T16:45:00Z",
      "visibility": "workspace",
      "tags": [
        {
          "id": "01887270-23f5-7da0-b95c-9a9e9ebc3c25",
          "name": "Sales",
          "color": "#FF5733"
        }
      ],
      "participants": [
        {
          "name": "John Doe",
          "email": "[email protected]",
          "profileImageUrl": "https://example.com/profiles/john.jpg",
          "accountName": "Caret",
          "accountDomain": "caret.so",
          "accountImageUrl": "https://example.com/logos/caret.png"
        },
        {
          "name": "Jane Smith",
          "email": "[email protected]",
          "profileImageUrl": "https://example.com/profiles/jane.jpg",
          "accountName": "Acme Corp",
          "accountDomain": "acme.com",
          "accountImageUrl": "https://example.com/logos/acme.png"
        }
      ],
      "totalDurationSec": 3600,
      "enhancedNote": "We discussed the integration timeline and requirements for the project. Key points include the need for API documentation and a Q4 2023 target release date.",
      "summary": "Discussed new feature requests and timeline for implementation."
    }
  ],
  "pagination": {
    "limit": 10,
    "nextOffset": 10,
    "isLast": false
  }
}