Records
Search for records
Finds records by any combination of record fields. String fields match an exact value or any of a list; numeric fields also accept ranges ({"$gte": 1000, "$lte": 4000}). Returns 200 with an empty data array when nothing matches.
Authorization
bearerAuth AuthorizationBearer <token>
Access token from POST /oauth2/token (valid for 300 seconds).
In: header
Request Body
application/json
country*string
filter*
Filter criteria. Every record field can be used; all conditions must match.
options?
Response Body
application/json
curl -X POST "https://example.com/api/records/find" \ -H "Content-Type: application/json" \ -d '{ "country": "se", "filter": { "range_key1": { "$gte": 1000, "$lte": 4000 }, "key4": "Shipping" }, "options": { "limit": 10, "offset": 0, "sort": [ { "key1": "asc" }, { "key2": "desc" } ] } }'{ "data": [ { "country": "se", "key": "d1c2e12cfeababc8b95daf6902e210b1", "record_key": "d1c2e12cfeababc8b95daf6902e210b1", "profile_key": "4274e510a2f41aeb9e8e0f8b56ff6c2", "range_key": 2000, "range_key1": 2000, "body": "{\"name\":\"John\",\"vehicle\":\"Audi\"}", "key1": "Additional info", "key4": "Shipping", "key10": "New", "created_at": "2021-03-26T11:57:45.000Z", "updated_at": "2021-03-26T11:57:45.000Z", "version": 0, "attachments": [] } ], "meta": { "count": 1, "limit": 10, "offset": 0, "total": 1 }}Update multiple records POST
Updates several records at once, matched by `search_key` (default `record_key`).
Aggregate records POST
Computes `count` and `sum` metrics over the records matching `filter`, optionally grouped. When there are more than 100 groups, the response has `meta.next`; send it back as `next` (alone) to get the next batch.