​
GETNotes

Fetch all notes. GET /user-api/v1/notes

​
Headers

HeaderValue
x-rolodex-api-keyf1e2d3c4b5a697...

​
Query Parameters

​
limit
string
Set a limit to the number of records to return (Default:25)
​
offset
string
Number of records to skip.
​
order_by
string
Sort order: updated_at:asc, updated_at:desc, created_at:asc, created_at:desc
​
include
string
Related data to include: contacts

​
Response

{
  "pagination": {
    "limit": 25,
    "offset": 0,
    "total": 250
  },
  "data": [
    {
      "id": "note_12345",
      "body": "Follow up meeting scheduled for next week",
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-15T10:30:00Z"
    },
    {
      "id": "note_67890",
      "body": "Great conversation about their tech stack",
      "created_at": "2025-01-14T09:15:00Z",
      "updated_at": "2025-01-14T09:15:00Z"
    }
  ]
}

​
With Include Parameters

GET /user-api/v1/notes?include=contacts

​
Response with all includes

{
  "pagination": {
    "limit": 25,
    "offset": 0,
    "total": 250
  },
  "data": [
    {
      "id": "note_12345",
      "body": "Follow up meeting scheduled for next week",
      "created_at": "2025-01-15T10:30:00Z",
      "updated_at": "2025-01-15T10:30:00Z",
      "contacts": [
        {
          "id": "contact_123",
          "full_name": "John Doe",
          "image_url": "https://example.com/avatar.jpg"
        }
      ]
    }
  ]
}

​
GET a Note

Fetch one note. GET /user-api/v1/notes/:id

​
Path Parameters

​
id
string
Note ID

​
Query Parameters

​
include
string
Related data to include: contacts

​
Endpoint Example

GET /user-api/v1/notes/note_12345?include=contacts

​
Response

{
  "data": {
    "id": "note_12345",
    "body": "Follow up meeting scheduled for next week",
    "created_at": "2025-01-15T10:30:00Z",
    "updated_at": "2025-01-15T10:30:00Z"
  }
}