GETNotes
Fetch all notes.
GET /user-api/v1/notes
| Header | Value |
|---|
x-rolodex-api-key | f1e2d3c4b5a697... |
Query Parameters
Set a limit to the number of records to return (Default:25)
Number of records to skip.
Sort order: updated_at:asc, updated_at:desc, created_at:asc, created_at:desc
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
Query Parameters
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"
}
}
