Administration

Employees

Endpoints for a business to manage their employees: invite, verify, remove, update roles.

Base URL: https://api.miridia.io. Read Authentication and Conventions before you call these operations.

Method	Path	Operation
GET	`/api/employees`	Get employees
POST	`/api/employee/{employeeId}/verify`	Verify employee
GET	`/api/employee/{employeeId}`	Get employee
DELETE	`/api/employee/{employeeId}`	Delete employee
PUT	`/api/employee/{userId}`	Update employee roles
POST	`/api/employee/invite`	Invite team member
DELETE	`/api/employee/{employeeId}/remove/{businessId}`	Remove team member

Get employees

GET/api/employees

Access. Send a bearer token or an API key. The caller needs the TeamAndRoles view permission.

Response

200. Returns a PagedResult envelope. Each item in data is PrimitiveUserAccountResponse.

Request

curl -X GET "https://api.miridia.io/api/employees" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

{
  "count": 0,
  "totalCount": 0,
  "page": 0,
  "finalPage": 0,
  "pageSize": 0,
  "hasMore": true,
  "statusCode": "OK",
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "title": "string",
      "firstName": "string",
      "lastName": "string",
      "email": "string",
      "phoneNumber": "string",
      "accountStatus": "Active",
      "acceptedTerms": true,
      "isVerified": true,
      "dateVerified": "2026-09-29T08:00:00Z",
      "address": {},
      "driver": {},
      "roles": [
        {}
      ],
      "userBusinesses": [
        {}
      ]
    }
  ],
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ]
}

Verify employee

POST/api/employee/{employeeId}/verify

Access. Send a bearer token or an API key. The caller needs the TeamAndRoles modify permission.

Parameters

Name	In	Type	Required	Description
`employeeId`	path	`string (uuid)`	Yes

Response

200. Returns a SingleResult envelope. The data field is boolean.

Request

curl -X POST "https://api.miridia.io/api/employee/{employeeId}/verify" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": true,
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Get employee

GET/api/employee/{employeeId}

Access. Send a bearer token or an API key. The caller needs the TeamAndRoles view permission.

Parameters

Name	In	Type	Required	Description
`employeeId`	path	`string (uuid)`	Yes

Response

200. Returns a SingleResult envelope. The data field is PrimitiveUserAccountResponse.

Request

curl -X GET "https://api.miridia.io/api/employee/{employeeId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Delete employee

DELETE/api/employee/{employeeId}

Access. Send a bearer token or an API key. The caller needs the TeamAndRoles delete permission.

Parameters

Name	In	Type	Required	Description
`employeeId`	path	`string (uuid)`	Yes

Response

200. Returns a SingleResult envelope. The data field is boolean.

Request

curl -X DELETE "https://api.miridia.io/api/employee/{employeeId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": true,
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Update employee roles

PUT/api/employee/{userId}

Access. Send a bearer token or an API key. The caller needs the TeamAndRoles modify permission.

Parameters

Name	In	Type	Required	Description
`userId`	path	`string (uuid)`	Yes

Request body

Send JSON with the shape UpdateEmployeeRolesCommand.

Field	Type	Required	Description
`roleIds`	`string (uuid)[]`	Yes

Response

200. Returns a SingleResult envelope. The data field is boolean.

Request

curl -X PUT "https://api.miridia.io/api/employee/{userId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "roleIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}'

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": true,
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Invite team member

POST/api/employee/invite

Access. Send a bearer token or an API key. The caller needs the TeamAndRoles modify permission.

Request body

Send JSON with the shape InviteTeamMemberCommand.

Field	Type	Required	Description
`email`	`string (email)`	Yes
`roles`	`enum UserRoles[]`	No	One of: `Sudo`, `Administrator`, `Manager`, `Operations`, `Driver`, `Accountant`, `General`, `Support`, `Unassigned`.

Response

200. Returns a SingleResult envelope. The data field is boolean.

Request

curl -X POST "https://api.miridia.io/api/employee/invite" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "name@example.com",
  "roles": [
    "Sudo"
  ]
}'

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": true,
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Remove team member

DELETE/api/employee/{employeeId}/remove/{businessId}

Access. Send a bearer token or an API key. The caller needs the TeamAndRoles modify permission.

Parameters

Name	In	Type	Required	Description
`employeeId`	path	`string (uuid)`	Yes
`businessId`	path	`string (uuid)`	Yes

Response

200. Returns a SingleResult envelope. The data field is boolean.

Request

curl -X DELETE "https://api.miridia.io/api/employee/{employeeId}/remove/{businessId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID"

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": true,
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Models

The operations on this page use these object types. Select a type to see its fields.

AddressResponse

Field	Type	Description
`id`	`string (uuid)`
`placeId`	`string`
`name`	`string`
`website`	`string`
`fullAddress`	`string`
`street`	`string`
`suburb`	`string`
`city`	`string`
`country`	`string`
`postcode`	`string`
`unit`	`string`
`number`	`string`
`province`	`string`
`latitude`	`number (double)`
`longitude`	`number (double)`

DriverResponse

Field	Type	Description
`id`	`string (uuid)`
`idNumber`	`string`
`licenseNumber`	`string`
`licenseTypeId`	`integer (int32)`
`licenseRenewalDate`	`string (date-time)`
`licenseIssuedDate`	`string (date-time)`
`user`	`DriverUserResponse`

DriverUserResponse

Field	Type	Description
`id`	`string (uuid)`
`firstName`	`string`
`lastName`	`string`
`email`	`string`
`phoneNumber`	`string`

PrimitiveUserAccountResponse

Field	Type	Description
`id`	`string (uuid)`
`title`	`string`
`firstName`	`string`
`lastName`	`string`
`email`	`string`
`phoneNumber`	`string`
`accountStatus`	`enum UserAccountStatus`	One of: `Active`, `Suspended`.
`acceptedTerms`	`boolean`
`isVerified`	`boolean`
`dateVerified`	`string (date-time)`
`address`	`AddressResponse`
`driver`	`DriverResponse`
`roles`	`RoleResponse[]`
`userBusinesses`	`UserBusinessResponse[]`

RoleResponse

Field	Type	Description
`id`	`string (uuid)`
`title`	`string`
`description`	`string`
`roleType`	`enum RoleType`	One of: `Default`, `Remote`, `Custom`.
`scope`	`enum RoleScope`	One of: `Branch`, `Franchise`.
`isSystem`	`boolean`
`permissions`	`object`
`peopleCount`	`integer (int32)`

UserBusinessResponse

Field	Type	Description
`businessId`	`string (uuid)`
`displayName`	`string`
`isDefault`	`boolean`
`currencyCode`	`enum CurrencyCode`	One of: `Invalid`, `Eur`, `Usd`, `Gbp`, `Zar`, `Zmw`.
`countryCode`	`enum CountryCode`	One of: `Invalid`, `Global`, `FallbackZa`, `Be`, `De`, `Lu`, `Nl`, `Za`, `Zw`, `Gb`, `Us`, `Zm`.

Teams

The teams operations of the Core API.

Users

The users operations of the Core API.