Minikai API documentation

{
  "labels": [
    {
      "id": "lbl-9f8a7c6d-1234-4b56-8e9f-0a1b2c3d4e5f",
      "name": "Mobility Assistance",
      "resourceType": "record",
      "labelGroupId": "grp-3e2d1c0b-5678-4a9b-8f7e-1d2c3b4a5f6e",
      "description": "Support required for walking and transfers",
      "colour": "#007A33",
      "icon": "wheelchair",
      "createdAt": "2024-05-10T08:15:00Z",
      "updatedAt": "2024-05-12T14:45:00Z"
    },
    {
      "id": "lbl-4b3a2c1d-6789-4e0f-9a8b-2c3d4e5f6a7b",
      "name": "Cognitive Support",
      "resourceType": "record",
      "labelGroupId": null,
      "description": "Assistance with memory and decision making",
      "colour": "#FF6F61",
      "icon": "brain",
      "createdAt": "2024-04-22T10:00:00Z",
      "updatedAt": "2024-05-01T09:30:00Z"
    }
  ],
  "labelGroups": [
    {
      "id": "grp-3e2d1c0b-5678-4a9b-8f7e-1d2c3b4a5f6e",
      "name": "Physical Care",
      "resourceType": "record",
      "createdAt": "2024-03-15T07:45:00Z",
      "updatedAt": "2024-05-10T08:00:00Z"
    },
    {
      "id": "grp-7f6e5d4c-3210-4b9a-8c7d-0e1f2a3b4c5d",
      "name": "Cognitive & Emotional",
      "resourceType": "record",
      "createdAt": "2024-02-20T11:30:00Z",
      "updatedAt": "2024-04-25T15:20:00Z"
    }
  ],
  "hasOrgWideAccess": true
}

Return the labels in the workspace.

Authentication

AuthorizationBearer

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

Query parameters

resourceTypestringOptional

Response

labelslist of objects

labelGroupslist of objects

hasOrgWideAccessboolean

Errors

400

Bad Request Error

1	from minikai import Minikai
2
3	client = Minikai(
4	token="YOUR_TOKEN_HERE",
5	)
6
7	client.labels.list_labels()