Search Records

POST

https://api.minikai.com/minikai-public/api/v1/Records/search

POST

/minikai-public/api/v1/Records/search

1 from minikai import Minikai
2 
3 client = Minikai(
4     token="YOUR_TOKEN_HERE",
5 )
6 
7 client.records.search_records(
8     mini_id="string",
9 )

1 {
2   "items": [
3     {
4       "item": {
5         "id": "string",
6         "title": "string",
7         "description": "string",
8         "createdAt": "2024-01-15T09:30:00Z",
9         "updatedAt": "2024-01-15T09:30:00Z",
10         "eventDate": "2024-01-15T09:30:00Z",
11         "createdBy": "string",
12         "updatedBy": "string",
13         "state": "active",
14         "ttl": null,
15         "attachments": [
16           {
17             "id": "string",
18             "fileName": "string",
19             "contentType": "string",
20             "size": null,
21             "checksum": "string",
22             "createdAt": "2024-01-15T09:30:00Z",
23             "updatedAt": "2024-01-15T09:30:00Z",
24             "createdBy": "string",
25             "updatedBy": "string",
26             "metadata": {}
27           }
28         ],
29         "authorization": {
30           "users": [
31             "string"
32           ],
33           "minis": [
34             "string"
35           ],
36           "organizations": [
37             "string"
38           ],
39           "sessions": [
40             "string"
41           ]
42         },
43         "relations": [
44           {
45             "relationship": "duplicate-of",
46             "id": "string",
47             "targetRecordId": "string",
48             "since": "2024-01-15T09:30:00Z"
49           }
50         ],
51         "externalUri": "string",
52         "labels": [
53           "string"
54         ],
55         "tags": {},
56         "eTag": "string"
57       },
58       "matchedFields": [
59         "string"
60       ]
61     }
62   ],
63   "totalCount": null,
64   "nextCursor": "string"
65 }

Full-text search across a Mini’s Records.

Authentication

AuthorizationBearer

Authenticate every request with Authorization: Bearer <api-key>. Manage keys in Workspace Admin > Security & access.

Request

This endpoint expects an object.

miniIdstringRequired

textstringOptional

labelslist of strings or nullOptional

stateslist of any or nullOptional

startDatedatetime or nullOptional

endDatedatetime or nullOptional

createdBylist of strings or nullOptional

updatedBylist of strings or nullOptional

cursorstring or nullOptional

limitanyOptional

sortenumOptional

Response

itemslist of objectsOptional

totalCountanyOptional

nextCursorstring or nullOptional

Errors

400

Bad Request Error