API docs by Redocly

Crinsurance Cloud API (1.0)

Download OpenAPI specification:

Crinsurance Cloud API

Clinics

Get clinics (paginated)

Returns a paginated list of clinics belonging to the authenticated user's organization

Authorizations:
Bearer
query Parameters
page
integer

Page number (default 1)

perPage
integer

Items per page (default 10)

depth
integer

Response depth level

name
string

Filter by clinic name

address
string

Filter by clinic address

phone
string

Filter by clinic phone

roleId
string

Filter by role ID

organizationId
string

Filter by organization ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page": 0,
  • "perPage": 0,
  • "total": 0
}

Create a new Clinic

Create a new Clinic

Authorizations:
Bearer
Request Body schema: application/json
required

Clinic object

address
required
string
name
required
string
organizationId
string
phone
required
string

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "name": "string",
  • "organizationId": "string",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "address": "string",
  • "id": "string",
  • "name": "string",
  • "organization": {
    },
  • "organizationId": "string",
  • "phone": "string"
}

Get available containers for insertion

Returns SCARF containers (CANE) in the user clinic that have enough available capacity to store the requested quantity of vitrification devices (VF).

Authorizations:
Bearer
query Parameters
qty
required
integer

Quantity of VF to insert

Responses

Response samples

Content type
application/json
[
  • [
    ]
]

Get Clinic detail

Get Clinic detail

Authorizations:
Bearer
path Parameters
id
required
integer

Clinic ID

query Parameters
depth
integer

Response depth level

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get clinic list

Returns all clinics of the user's organization (no pagination).

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update a Clinic

Updates Clinic information by ID. Only admins can perform this action.

Authorizations:
Bearer
path Parameters
id
required
integer

Clinic ID

Request Body schema: application/json
required

Clinic update payload

address
required
string
id
required
string
name
required
string
phone
required
string

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "id": "string",
  • "name": "string",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "message": "Success message"
}

Delete a Clinic

Deletes a Clinic by ID

Authorizations:
Bearer
path Parameters
id
required
integer

Clinic ID

Responses

Response samples

Content type
application/json
{
  • "message": "Success message"
}

Containers

Get container detail

Returns a container by id. Supports depth to include related data (supports, tag, etc).

Authorizations:
Bearer
path Parameters
id
required
string

Container ID (uuid)

query Parameters
depth
integer

Depth of relations

supports
string
Enum: "all" "inserted"

Filter supports: all | inserted

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "isUsable": true,
  • "name": "string",
  • "procedureStatus": "string",
  • "supports": [
    ],
  • "tag": {
    }
}

Validate container by RFID

Validates that the RFID belongs to a container tag, that it is not inserted, and that it has no inserted supports

Authorizations:
Bearer
path Parameters
rfid
required
string

RFID of the container tag

Responses

Response samples

Content type
application/json
{
  • "exists": true,
  • "reason": "string",
  • "valid": true
}

Me

Get own user profile

Returns the authenticated user's information

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "clinic": {
    },
  • "clinicId": "string",
  • "createdAt": "string",
  • "email": "string",
  • "id": "string",
  • "lastLogin": "string",
  • "name": "string",
  • "phone": "string",
  • "role": {
    },
  • "roleId": "string",
  • "surname": "string",
  • "updatedAt": "string"
}

Update a user

Updates user information by ID

Authorizations:
Bearer
Request Body schema: application/json
required

User update payload

active
boolean
clinicId
string
email
string
name
string
phone
string
roleId
string
surname
string

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "clinicId": "string",
  • "email": "string",
  • "name": "string",
  • "phone": "string",
  • "roleId": "string",
  • "surname": "string"
}

Response samples

Content type
application/json
{
  • "message": "Success message"
}

Get user logs

Returns the activity log entries for a specific user

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Login a user

Login a user

Request Body schema: application/json
required

User object

email
required
string
password
required
string

Responses

Request samples

Content type
application/json
{
  • "email": "string",
  • "password": "string"
}

Response samples

Content type
application/json
{
  • "token": "string",
  • "user": {
    }
}

Change user password

Changes the password of a specific user

Authorizations:
Bearer
Request Body schema: application/json
required

Password change payload

currentPassword
required
string
newPassword
required
string >= 8 characters

Responses

Request samples

Content type
application/json
{
  • "currentPassword": "string",
  • "newPassword": "stringst"
}

Response samples

Content type
application/json
{
  • "message": "Success message"
}

Organizations

Get organization (by logged user)

Returns the organization associated with the authenticated user

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "address": "string",
  • "id": "string",
  • "name": "string",
  • "phone": "string"
}

Update an organization

Updates organization information

Authorizations:
Bearer
Request Body schema: application/json
required

Organization update payload

address
required
string
name
required
string
phone
required
string

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "name": "string",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "address": "string",
  • "id": "string",
  • "name": "string",
  • "phone": "string"
}

Create a new organization

Creates a new organization

Authorizations:
Bearer
Request Body schema: application/json
required

Organization create payload

address
required
string
name
required
string
phone
required
string

Responses

Request samples

Content type
application/json
{
  • "address": "string",
  • "name": "string",
  • "phone": "string"
}

Response samples

Content type
application/json
{
  • "address": "string",
  • "id": "string",
  • "name": "string",
  • "phone": "string"
}

Delete an organization

Deletes an organization if it has no associated clinics

Authorizations:
Bearer
path Parameters
id
required
string

Organization ID

Responses

Response samples

Content type
application/json
{
  • "message": "Success message"
}

Get organization clinics

Returns all clinics belonging to a specific organization

Authorizations:
Bearer
path Parameters
id
required
string

Organization ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Patients

Get patients (paginated)

Returns a paginated list of patients

Authorizations:
Bearer
query Parameters
page
integer

Page number (default 1)

perPage
integer

Items per page (default 10)

depth
integer

Response depth level

name
string

Filter by patient name

surname
string

Filter by patient surname

code
string

Filter by patient code

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page": 0,
  • "perPage": 0,
  • "total": 0
}

Create a new patient

Creates a new patient

Authorizations:
Bearer
Request Body schema: application/json
required

Patient create payload

code
required
string
name
required
string
surname
required
string

Responses

Request samples

Content type
application/json
{
  • "code": "string",
  • "name": "string",
  • "surname": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "id": "string",
  • "name": "string",
  • "supports": [
    ],
  • "surname": "string"
}

Get patients (paginated)

Returns a paginated list of patients

Authorizations:
Bearer
query Parameters
page
integer

Page number (default 1)

perPage
integer

Items per page (default 10)

depth
integer

Response depth level

name
string

Filter by patient name

surname
string

Filter by patient surname

code
string

Filter by patient code

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page": 0,
  • "perPage": 0,
  • "total": 0
}

Get patient detail

Returns patient detail by ID

Authorizations:
Bearer
path Parameters
id
required
string

Patient ID

query Parameters
depth
integer

Response depth level

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "id": "string",
  • "name": "string",
  • "supports": [
    ],
  • "surname": "string"
}

Edit an existing patient

Updates an existing patient by ID

Authorizations:
Bearer
path Parameters
id
required
string

Patient ID

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "id": "string",
  • "name": "string",
  • "supports": [
    ],
  • "surname": "string"
}

Delete a patient

Deletes a patient by ID

Authorizations:
Bearer
path Parameters
id
required
string

Patient ID

Responses

Response samples

Content type
application/json
{
  • "message": "Success message"
}

Get patient supports grouped by type

Returns patient supports grouped in ARDI (supports without container) and SCARF (containers with supports). Can be filtered by inserted state.

Authorizations:
Bearer
path Parameters
id
required
string

Patient ID

query Parameters
inserted
boolean

Filter by inserted state (true | false)

excludeInActiveProcedures
boolean

Filter by the elements are in a procedure active (true | false)

Responses

Response samples

Content type
application/json
{ }

Procedures

List procedures

Get paginated list of procedures

Authorizations:
Bearer
query Parameters
code
string

Procedure code

procedureTypeId
string

Procedure type ID

storageTypeId
string

Storage type ID

statusId
string

Status ID

userCreatorId
string

Creator user ID

userExecutorId
string

Executor user ID

page
integer

Page number

limit
integer

Page size

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create procedure

Create a new procedure with its items (ARDI or SCARF) in a single request

Authorizations:
Bearer
Request Body schema: application/json
required

Create procedure with items payload

required
object (requestTypes.ProcedureItems)
required
object (requestTypes.CreateProcedureData)

Responses

Request samples

Content type
application/json
{
  • "items": {
    },
  • "procedure": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "containers": [
    ],
  • "created": "string",
  • "history": [
    ],
  • "id": "string",
  • "patient": {
    },
  • "procedureType": {
    },
  • "procedureTypeId": "string",
  • "refill": {
    },
  • "status": {
    },
  • "statusId": "string",
  • "storage": {
    },
  • "storageType": {
    },
  • "storageTypeId": "string",
  • "supports": [
    ],
  • "updated": "string",
  • "userCreator": {
    },
  • "userCreatorId": "string",
  • "userExecutor": {
    },
  • "userExecutorId": "string"
}

Create refill procedure

Create a new refill procedure and its initial refill data

Authorizations:
Bearer
Request Body schema: application/json
required

Refill procedure payload

lnBefore
required
integer
storageId
required
string

Responses

Request samples

Content type
application/json
{
  • "lnBefore": 0,
  • "storageId": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "containers": [
    ],
  • "created": "string",
  • "history": [
    ],
  • "id": "string",
  • "patient": {
    },
  • "procedureType": {
    },
  • "procedureTypeId": "string",
  • "refill": {
    },
  • "status": {
    },
  • "statusId": "string",
  • "storage": {
    },
  • "storageType": {
    },
  • "storageTypeId": "string",
  • "supports": [
    ],
  • "updated": "string",
  • "userCreator": {
    },
  • "userCreatorId": "string",
  • "userExecutor": {
    },
  • "userExecutorId": "string"
}

Create register storage procedure

Initializes a REGISTER_STORAGE procedure for SCARF storage. This step only creates the procedure and its initial history (CREATED).

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "containers": [
    ],
  • "created": "string",
  • "history": [
    ],
  • "id": "string",
  • "patient": {
    },
  • "procedureType": {
    },
  • "procedureTypeId": "string",
  • "refill": {
    },
  • "status": {
    },
  • "statusId": "string",
  • "storage": {
    },
  • "storageType": {
    },
  • "storageTypeId": "string",
  • "supports": [
    ],
  • "updated": "string",
  • "userCreator": {
    },
  • "userCreatorId": "string",
  • "userExecutor": {
    },
  • "userExecutorId": "string"
}

Get procedure types

Get procedure types

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get procedure detail

Get procedure detail by ID

Authorizations:
Bearer
path Parameters
id
required
string

Procedure ID

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "containers": [
    ],
  • "created": "string",
  • "history": [
    ],
  • "id": "string",
  • "patient": {
    },
  • "procedureType": {
    },
  • "procedureTypeId": "string",
  • "refill": {
    },
  • "status": {
    },
  • "statusId": "string",
  • "storage": {
    },
  • "storageType": {
    },
  • "storageTypeId": "string",
  • "supports": [
    ],
  • "updated": "string",
  • "userCreator": {
    },
  • "userCreatorId": "string",
  • "userExecutor": {
    },
  • "userExecutorId": "string"
}

Delete procedure

Permanently delete a cancelled procedure (for test cleanup)

Authorizations:
Bearer
path Parameters
id
required
string

Procedure ID

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Cancel procedure

Cancel a procedure if its current status allows it

Authorizations:
Bearer
path Parameters
id
required
string

Procedure ID

Responses

Complete procedure

Finalize a procedure after execution (STORE or RETRIEVE)

Authorizations:
Bearer
path Parameters
id
required
string

Procedure ID

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "containers": [
    ],
  • "created": "string",
  • "history": [
    ],
  • "id": "string",
  • "patient": {
    },
  • "procedureType": {
    },
  • "procedureTypeId": "string",
  • "refill": {
    },
  • "status": {
    },
  • "statusId": "string",
  • "storage": {
    },
  • "storageType": {
    },
  • "storageTypeId": "string",
  • "supports": [
    ],
  • "updated": "string",
  • "userCreator": {
    },
  • "userCreatorId": "string",
  • "userExecutor": {
    },
  • "userExecutorId": "string"
}

Extract supports

Physically extract supports for a retrieve procedure (RETRIEVE execution)

Authorizations:
Bearer
path Parameters
id
required
string

Procedure ID

Request Body schema: application/json
required

Extract supports payload

Array of objects (requestTypes.ExtractARDIItem)
object (requestTypes.ExtractSCARFItem)

Responses

Request samples

Content type
application/json
{
  • "ardi": [
    ],
  • "scarf": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "containers": [
    ],
  • "created": "string",
  • "history": [
    ],
  • "id": "string",
  • "patient": {
    },
  • "procedureType": {
    },
  • "procedureTypeId": "string",
  • "refill": {
    },
  • "status": {
    },
  • "statusId": "string",
  • "storage": {
    },
  • "storageType": {
    },
  • "storageTypeId": "string",
  • "supports": [
    ],
  • "updated": "string",
  • "userCreator": {
    },
  • "userCreatorId": "string",
  • "userExecutor": {
    },
  • "userExecutorId": "string"
}

Insert supports

Physically insert supports or containers for a STORE procedure execution.

The request body depends on the storage type:

  • ARDI: InsertSupportARDIRequest
  • SCARF: InsertSupportSCARFRequest
Authorizations:
Bearer
path Parameters
id
required
string

Procedure ID

Request Body schema: application/json
required

ARDI or SCARF payload (depends on storage type)

object

Responses

Request samples

Content type
application/json
{ }

Response samples

Content type
application/json
{
  • "code": "string",
  • "containers": [
    ],
  • "created": "string",
  • "history": [
    ],
  • "id": "string",
  • "patient": {
    },
  • "procedureType": {
    },
  • "procedureTypeId": "string",
  • "refill": {
    },
  • "status": {
    },
  • "statusId": "string",
  • "storage": {
    },
  • "storageType": {
    },
  • "storageTypeId": "string",
  • "supports": [
    ],
  • "updated": "string",
  • "userCreator": {
    },
  • "userCreatorId": "string",
  • "userExecutor": {
    },
  • "userExecutorId": "string"
}

Complete refill procedure

Complete a refill procedure, updating LN data and moving status to COMPLETED

Authorizations:
Bearer
path Parameters
id
required
string

Procedure ID (UUID)

Request Body schema: application/json
required

Refill completion payload

lnAfter
required
integer
observations
string

Responses

Request samples

Content type
application/json
{
  • "lnAfter": 0,
  • "observations": "string"
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "containers": [
    ],
  • "created": "string",
  • "history": [
    ],
  • "id": "string",
  • "patient": {
    },
  • "procedureType": {
    },
  • "procedureTypeId": "string",
  • "refill": {
    },
  • "status": {
    },
  • "statusId": "string",
  • "storage": {
    },
  • "storageType": {
    },
  • "storageTypeId": "string",
  • "supports": [
    ],
  • "updated": "string",
  • "userCreator": {
    },
  • "userCreatorId": "string",
  • "userExecutor": {
    },
  • "userExecutorId": "string"
}

Start refill procedure

Move a refill procedure from CREATED to IN_PROGRESS status

Authorizations:
Bearer
path Parameters
id
required
string

Procedure ID (UUID)

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "containers": [
    ],
  • "created": "string",
  • "history": [
    ],
  • "id": "string",
  • "patient": {
    },
  • "procedureType": {
    },
  • "procedureTypeId": "string",
  • "refill": {
    },
  • "status": {
    },
  • "statusId": "string",
  • "storage": {
    },
  • "storageType": {
    },
  • "storageTypeId": "string",
  • "supports": [
    ],
  • "updated": "string",
  • "userCreator": {
    },
  • "userCreatorId": "string",
  • "userExecutor": {
    },
  • "userExecutorId": "string"
}

Complete register storage procedure

Complete a register storage procedure

Authorizations:
Bearer
path Parameters
id
required
string

Procedure ID (UUID)

Responses

Response samples

Content type
application/json
{
  • "code": "string",
  • "containers": [
    ],
  • "created": "string",
  • "history": [
    ],
  • "id": "string",
  • "patient": {
    },
  • "procedureType": {
    },
  • "procedureTypeId": "string",
  • "refill": {
    },
  • "status": {
    },
  • "statusId": "string",
  • "storage": {
    },
  • "storageType": {
    },
  • "storageTypeId": "string",
  • "supports": [
    ],
  • "updated": "string",
  • "userCreator": {
    },
  • "userCreatorId": "string",
  • "userExecutor": {
    },
  • "userExecutorId": "string"
}

Execute register storage procedure

Executes a REGISTER_STORAGE procedure for SCARF storages. Creates the storage, its canister mappings (tags + positions), updates the procedure status to COMPLETED and records history.

Authorizations:
Bearer
path Parameters
id
required
string

Procedure ID

Request Body schema: application/json
required

Register storage execution payload

Array of objects (requestTypes.CanisterRequest)
object (requestTypes.StorageRegisterRequest)

Responses

Request samples

Content type
application/json
{
  • "canisters": [
    ],
  • "storage": {
    }
}

Response samples

Content type
application/json
{
  • "code": "string",
  • "containers": [
    ],
  • "created": "string",
  • "history": [
    ],
  • "id": "string",
  • "patient": {
    },
  • "procedureType": {
    },
  • "procedureTypeId": "string",
  • "refill": {
    },
  • "status": {
    },
  • "statusId": "string",
  • "storage": {
    },
  • "storageType": {
    },
  • "storageTypeId": "string",
  • "supports": [
    ],
  • "updated": "string",
  • "userCreator": {
    },
  • "userCreatorId": "string",
  • "userExecutor": {
    },
  • "userExecutorId": "string"
}

Roles

List roles

Returns all roles

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new role

Creates a new user role

Authorizations:
Bearer
Request Body schema: application/json
required

Role object

createdAt
string
id
string
name
string
updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "createdAt": "string",
  • "id": "string",
  • "name": "string",
  • "updatedAt": "string"
}

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "id": "string",
  • "name": "string",
  • "updatedAt": "string"
}

Get role detail

Returns details of a specific role

Authorizations:
Bearer
path Parameters
id
required
integer

Role ID

Responses

Response samples

Content type
application/json
{
  • "createdAt": "string",
  • "id": "string",
  • "name": "string",
  • "updatedAt": "string"
}

Update role

Updates the name of a role

Authorizations:
Bearer
path Parameters
id
required
integer

Role ID

Request Body schema: application/json
required

Role payload

createdAt
string
id
string
name
string
updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "createdAt": "string",
  • "id": "string",
  • "name": "string",
  • "updatedAt": "string"
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Delete role

Deletes a role by ID

Authorizations:
Bearer
path Parameters
id
required
integer

Role ID

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Get role permissions

Returns the permission matrix (GET/POST/PUT/DELETE) for this role

Authorizations:
Bearer
path Parameters
id
required
integer

Role ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update role permissions

Updates the full permission matrix for this role

Authorizations:
Bearer
path Parameters
id
required
integer

Role ID

Request Body schema: application/json
required

Permission matrix

Array of objects (stores.UpdatePermissionItem)

Responses

Request samples

Content type
application/json
{
  • "permissions": [
    ]
}

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Storages

Get storages (paginated)

Returns a paginated list of storages belonging to the authenticated user's organization

Authorizations:
Bearer
query Parameters
page
integer

Page number (default 1)

perPage
integer

Items per page (default 10)

depth
integer

Response depth level

name
string

Filter by storage name

serial
string

Filter by storage serial

manufacturer
string

Filter by storage manufacturer

storageTypeID
string

Filter by storage type ID

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page": 0,
  • "perPage": 0,
  • "total": 0
}

Create a new storage

Creates a new storage

Authorizations:
Bearer
Request Body schema: application/json
required

Storage create payload

clinicID
required
string
manufacturer
required
string
name
required
string
serial
required
string
storageModelID
required
string

Responses

Request samples

Content type
application/json
{
  • "clinicID": "string",
  • "manufacturer": "string",
  • "name": "string",
  • "serial": "string",
  • "storageModelID": "string"
}

Response samples

Content type
application/json
{
  • "clinic": {
    },
  • "clinicId": "string",
  • "id": "string",
  • "ln2Capacity": 0,
  • "manufacturer": "string",
  • "mapping": [
    ],
  • "name": "string",
  • "readerSerial": "string",
  • "serial": "string",
  • "storageModel": {
    },
  • "storageModelId": "string"
}

Get storage list

Returns a list of storages belonging to the authenticated user's organization (no pagination)

Authorizations:
Bearer
query Parameters
depth
integer

Response depth level

name
string

Filter by storage name

serial
string

Filter by storage serial

manufacturer
string

Filter by storage manufacturer

storageTypeID
string

Filter by storage type ID

clinicID
string

Filter by clinic ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get storage detail

Returns storage detail by ID

Authorizations:
Bearer
path Parameters
id
required
string

Storage ID

query Parameters
depth
integer

Response depth level

Responses

Response samples

Content type
application/json
{
  • "clinic": {
    },
  • "clinicId": "string",
  • "id": "string",
  • "ln2Capacity": 0,
  • "manufacturer": "string",
  • "mapping": [
    ],
  • "name": "string",
  • "readerSerial": "string",
  • "serial": "string",
  • "storageModel": {
    },
  • "storageModelId": "string"
}

Update a storage

Updates a storage by ID

Authorizations:
Bearer
path Parameters
id
required
string

Storage ID

Request Body schema: application/json
required

Storage update payload

clinicID
string
manufacturer
string
name
string
serial
string
storageTypeID
string

Responses

Request samples

Content type
application/json
{
  • "clinicID": "string",
  • "manufacturer": "string",
  • "name": "string",
  • "serial": "string",
  • "storageTypeID": "string"
}

Response samples

Content type
application/json
{
  • "clinic": {
    },
  • "clinicId": "string",
  • "id": "string",
  • "ln2Capacity": 0,
  • "manufacturer": "string",
  • "mapping": [
    ],
  • "name": "string",
  • "readerSerial": "string",
  • "serial": "string",
  • "storageModel": {
    },
  • "storageModelId": "string"
}

Delete a storage

Deletes a storage by ID

Authorizations:
Bearer
path Parameters
id
required
string

Storage ID

Responses

Response samples

Content type
application/json
{
  • "message": "Success message"
}

StorageModels

Get storage models

Returns a list of storage models (e.g., Default-ARDI, Default-SCARF)

Authorizations:
Bearer
query Parameters
depth
integer

Response depth level

Responses

Response samples

Content type
application/json
[
  • {
    }
]

StorageTypes

Get storage types

Returns a list of storage types

Authorizations:
Bearer

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Storage

Get storage mapping

Returns the storage structure mapping with RFID tags (depth-based)

Authorizations:
Bearer
path Parameters
id
required
string

Storage ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tags

Check if RFID is available

Validates if an RFID does not exist in the system

Authorizations:
Bearer
query Parameters
rfid
required
string

RFID code

Responses

Response samples

Content type
application/json
{
  • "status": true
}

Users

Get paginated list of users

Returns a paginated list of users filtered by clinic. Filtering You can filter by the following fields: email, name, surname, phone, roleId, clinicId, isActive, lastLogin

Operators

  • Exact match: field=value
  • Like (case-insensitive): field_like=value
  • In list: field_in=value1,value2
  • From (>=): field_from=value
  • To (<=): field_to=value Depth Controls how many levels of related entities are included.
  • 0: Only user data (default)
  • 1: Includes (clinic)
  • 2: Includes (clinic + organizations)
Authorizations:
Bearer
query Parameters
page
integer

Page number (default 1)

perPage
integer

Items per page (default 10)

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "page": 0,
  • "perPage": 0,
  • "total": 0
}

Create a new user

Creates a new user

Authorizations:
Bearer
Request Body schema: application/json
required

User object

active
required
boolean
clinicId
required
string
email
required
string
name
required
string
phone
string
roleId
required
string
surname
required
string

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "clinicId": "string",
  • "email": "string",
  • "name": "string",
  • "phone": "string",
  • "roleId": "string",
  • "surname": "string"
}

Response samples

Content type
application/json
{
  • "active": true,
  • "clinic": {
    },
  • "clinicId": "string",
  • "createdAt": "string",
  • "email": "string",
  • "id": "string",
  • "lastLogin": "string",
  • "name": "string",
  • "phone": "string",
  • "role": {
    },
  • "roleId": "string",
  • "surname": "string",
  • "updatedAt": "string"
}

Get user detail

Returns detailed information about a specific user

Authorizations:
Bearer
path Parameters
id
required
integer

User ID

Responses

Response samples

Content type
application/json
{
  • "active": true,
  • "clinic": {
    },
  • "clinicId": "string",
  • "created": "string",
  • "email": "string",
  • "id": "string",
  • "lastLogin": "string",
  • "name": "string",
  • "phone": "string",
  • "role": {
    },
  • "roleId": "string",
  • "surname": "string",
  • "updated": "string"
}

Update a user

Updates user information by ID

Authorizations:
Bearer
path Parameters
id
required
integer

User ID

Request Body schema: application/json
required

User update payload

active
boolean
clinicId
string
email
string
name
string
phone
string
roleId
string
surname
string

Responses

Request samples

Content type
application/json
{
  • "active": true,
  • "clinicId": "string",
  • "email": "string",
  • "name": "string",
  • "phone": "string",
  • "roleId": "string",
  • "surname": "string"
}

Response samples

Content type
application/json
{
  • "message": "Success message"
}

Delete a user

Deletes a user by ID

Authorizations:
Bearer
path Parameters
id
required
string

User ID

Responses

Response samples

Content type
application/json
{
  • "message": "Success message"
}

Get user logs

Returns the activity log entries for a specific user

Authorizations:
Bearer
path Parameters
id
required
integer

User ID

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Change user password

Changes the password of a specific user

Authorizations:
Bearer
path Parameters
id
required
integer

User ID

Request Body schema: application/json
required

Password change payload

currentPassword
required
string
newPassword
required
string >= 8 characters

Responses

Request samples

Content type
application/json
{
  • "currentPassword": "string",
  • "newPassword": "stringst"
}

Response samples

Content type
application/json
{
  • "message": "Success message"
}

Health

Health check endpoint

Returns the health status of the API for load balancer/container orchestration

Responses

Response samples

Content type
application/json
{
  • "status": "string",
  • "time": "string"
}