List Records

GET

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

GET

/minikai-public/api/v1/Records

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

200Retrieved

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

List a Mini's Records, optionally filtered by labels, states, dates, or content keys.

Authentication

AuthorizationBearer

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

Query parameters

miniIdstringRequired

recordIdslist of stringsOptional

externalUrislist of stringsOptional

recordIdstringOptionalformat: "uuid"

beforeCursorstringOptionalformat: "uuid"

afterCursorstringOptionalformat: "uuid"

limitBeforeanyOptional

limitAfteranyOptional

labelslist of stringsOptional

stateslist of stringsOptional

startDatedatetimeOptional

endDatedatetimeOptional

createdBylist of stringsOptional

updatedBylist of stringsOptional

sortDescendingbooleanOptionalDefaults to true

includeTotalCountbooleanOptionalDefaults to false

contentFilterslist of stringsOptional

Response

itemslist of objects

beforeCursorstring or null

afterCursorstring or null

totalCountanyOptional