Records
Creating Records
Request Body:
{
"records": [
{
"fields": {
"name": "John Doe",
"email": "john@example.com",
"age": 30
}
}
]
}
Response:
{
"records": [
{
"id": "rec123",
"fields": {
"name": "John Doe",
"email": "john@example.com",
"age": 30
},
"created_time": "2025-02-04T12:00:00Z"
}
]
}
Querying Records
Request Body:
{
"filters": [
{ "field": "age", "operator": "gte", "value": 25 }
],
"sort": [
{ "field": "created_time", "direction": "desc" }
],
"fields": ["name", "email"],
"limit": 10,
"page_token": null
}
Response:
{
"total": 100,
"records": [
{
"id": "rec456",
"fields": {
"name": "Jane Doe",
"email": "jane@example.com"
}
}
],
"next_page_token": "abc123"
}
Searching Records
Response:
{
"records": [
{
"id": "rec789",
"fields": {
"name": "John Smith",
"email": "john.smith@example.com"
}
}
]
}
Fetching a Single Record
Response:
{
"record": {
"id": "rec123",
"fields": {
"name": "John Doe",
"email": "john@example.com",
"age": 30
}
}
}
Updating Records
Request Body:
{
"records": [
{
"id": "rec123",
"fields": { "age": 31 }
}
]
}
Response:
{
"records": [
{
"id": "rec123",
"fields": { "age": 31 }
}
]
}
Deleting Records
Request Body:
{
"record_ids": ["rec123", "rec456"]
}
Response:
{
"msg": "Records deleted successfully"
}
Conclusion
Modified at 2025-02-04 20:50:20