Kits

List Kits

get

Retrieves all kits from the Golain system

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Query parameters

limitnumberOptional

Limit

Example: 10

pagenumberOptional

Page number

sortstringOptional

Sort order

Example: asc

orderstringOptional

Sort field

Example: createdAt

idstringOptional

Kit ID

Example: kit_123

namestringOptional

Kit name

Example: Blood Test Kit

assignedTostringOptional

Patient ID assigned to the kit

Example: patient_123

assignedBystringOptional

User ID who assigned the kit

Example: user_123

assignedbooleanOptional

Kit assigned status

Example: true

assignedAtStartone ofOptional

Assignment start date

Example: 2024-01-01T00:00:00Z

string · dateOptional

or

string · date-timeOptional

assignedAtEndone ofOptional

Assignment end date

Example: 2024-01-01T00:00:00Z

string · dateOptional

or

string · date-timeOptional

createdAtStartone ofOptional

Creation start date

Example: 2024-01-01T00:00:00Z

string · dateOptional

or

string · date-timeOptional

createdAtEndone ofOptional

Creation end date

Example: 2024-01-01T00:00:00Z

string · dateOptional

or

string · date-timeOptional

Responses

200Success

application/json

get

/api/rpm/kits

HTTPcURLJavaScriptPython

GET /api/rpm/kits HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

[
  {
    "id": "kit_123",
    "name": "Blood Test Kit",
    "metadata": {
      "description": "Kit for collecting blood samples",
      "availableDevicesInKit": {
        "bgm": true,
        "bpm": false,
        "weightscale": true,
        "spo2": false,
        "temperature": false,
        "pulse": true
      }
    },
    "createdAt": "text",
    "assigned": true,
    "assignedTo": "patient_123",
    "assignedBy": "user_123",
    "assignedAt": "2025-12-15"
  }
]

Create Kit

post

Creates a new kit in the Golain system

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Body

application/json

namestring · min: 1Required

Kit name

Example: Blood Test Kit

descriptionstringOptional

Kit description

Example: Kit for collecting blood samples

Responses

200Success

application/json

post

/api/rpm/kits

HTTPcURLJavaScriptPython

POST /api/rpm/kits HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "name": "Blood Test Kit",
  "description": "Kit for collecting blood samples"
}

200Success

{
  "id": "kit_123",
  "name": "Blood Test Kit",
  "metadata": {
    "description": "Kit for collecting blood samples",
    "availableDevicesInKit": {
      "bgm": true,
      "bpm": false,
      "weightscale": true,
      "spo2": false,
      "temperature": false,
      "pulse": true
    }
  },
  "createdAt": "text",
  "assigned": true,
  "assignedTo": "patient_123",
  "assignedBy": "user_123",
  "assignedAt": "2025-12-15"
}

Get Kit

get

Retrieves a specific kit by it's ID

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

idstringRequiredPattern: [^\/#\?]+?

Responses

200Success

application/json

get

/api/rpm/kits/{id}

HTTPcURLJavaScriptPython

GET /api/rpm/kits/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200Success

{
  "id": "kit_123",
  "name": "Blood Test Kit",
  "metadata": {
    "description": "Kit for collecting blood samples",
    "availableDevicesInKit": {
      "bgm": true,
      "bpm": false,
      "weightscale": true,
      "spo2": false,
      "temperature": false,
      "pulse": true
    }
  },
  "createdAt": "text",
  "assigned": true,
  "assignedTo": "patient_123",
  "assignedBy": "user_123",
  "assignedAt": "2025-12-15"
}

Delete Kit

delete

Deletes a kit from the Golain system

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

idstringRequiredPattern: [^\/#\?]+?

Responses

200

Successful response

application/json

delete

/api/rpm/kits/{id}

HTTPcURLJavaScriptPython

DELETE /api/rpm/kits/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Accept: */*

200

Successful response

No content

Update Kit

patch

Updates the kit name and description

Authorizations

bearerAuth & organizationCodeapiKeyAuth & organizationCode

AuthorizationstringRequired

Enter your Bearer token

organization_codestringRequired

Enter your organization code

Path parameters

idstringRequiredPattern: [^\/#\?]+?

Body

application/json

namestring · min: 1Required

Kit name

Example: Blood Test Kit

descriptionstringOptional

Kit description

Example: Kit for collecting blood samples

Responses

200Success

application/json

patch

/api/rpm/kits/{id}

HTTPcURLJavaScriptPython

PATCH /api/rpm/kits/{id} HTTP/1.1
Host: platform-api-development.azo.dev
Authorization: Bearer YOUR_SECRET_TOKEN
organization_code: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 74

{
  "name": "Blood Test Kit",
  "description": "Kit for collecting blood samples"
}

200Success

{
  "id": "kit_123",
  "name": "Blood Test Kit",
  "metadata": {
    "description": "Kit for collecting blood samples",
    "availableDevicesInKit": {
      "bgm": true,
      "bpm": false,
      "weightscale": true,
      "spo2": false,
      "temperature": false,
      "pulse": true
    }
  },
  "createdAt": "text",
  "assigned": true,
  "assignedTo": "patient_123",
  "assignedBy": "user_123",
  "assignedAt": "2025-12-15"
}