Administration

Teams

The teams operations of the Core API.

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

Method	Path	Operation
GET	`/api/v1/teams`	Get teams
POST	`/api/v1/teams`	Create team
GET	`/api/v1/teams/{teamId}`	Get team
PUT	`/api/v1/teams/{teamId}`	Update team
DELETE	`/api/v1/teams/{teamId}`	Delete team

Get teams

GET/api/v1/teams

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

Parameters

Name	In	Type	Required	Description
`Page`	query	`integer (int32)`	No	Limits: minimum 1.
`PageSize`	query	`integer (int32)`	No	Limits: minimum 1, maximum 100.
`$orderby`	query	`string`	No	Example: "created_at desc" or "name asc"
`$filter`	query	`string`	No	Apply a ODATA style filter to the query to add a fixed constraint. For example, if you want to filter by the creation date, you would set the filter to "created_at ge 2022-01-01". Or if you want to filter by a specific status, you would set the filter to "status eq 'active'".
`$search`	query	`string`	No	Provide a search value which would inherit the 'CONTAINS' behaviour.
`isEnabled`	query	`boolean`	No

Response

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

Request

curl -X GET "https://api.miridia.io/api/v1/teams" \
  -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",
      "name": "string",
      "description": "string",
      "color": "string",
      "enabled": true,
      "members": [
        {}
      ],
      "dateCreated": "2026-09-29T08:00:00Z",
      "dateModified": "2026-09-29T08:00:00Z"
    }
  ],
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ]
}

Create team

POST/api/v1/teams

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

Request body

Send JSON with the shape CreateTeamCommand.

Field	Type	Required
`name`	`string`	Yes
`description`	`string`	No
`color`	`string`	No
`memberUserIds`	`string (uuid)[]`	No

Response

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

Request

curl -X POST "https://api.miridia.io/api/v1/teams" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string",
  "color": "string",
  "memberUserIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}'

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "color": "string",
    "enabled": true,
    "members": [
      {}
    ],
    "dateCreated": "2026-09-29T08:00:00Z",
    "dateModified": "2026-09-29T08:00:00Z"
  },
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Get team

GET/api/v1/teams/{teamId}

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

Parameters

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

Response

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

Request

curl -X GET "https://api.miridia.io/api/v1/teams/{teamId}" \
  -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": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "color": "string",
    "enabled": true,
    "members": [
      {}
    ],
    "dateCreated": "2026-09-29T08:00:00Z",
    "dateModified": "2026-09-29T08:00:00Z"
  },
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Update team

PUT/api/v1/teams/{teamId}

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

Parameters

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

Request body

Send JSON with the shape UpdateTeamCommand.

Field	Type	Required	Description
`name`	`string`	Yes
`description`	`string`	No
`color`	`string`	No
`isEnabled`	`boolean`	No
`memberUserIds`	`string (uuid)[]`	No	The full member list. Replaces the current membership.

Response

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

Request

curl -X PUT "https://api.miridia.io/api/v1/teams/{teamId}" \
  -H "Authorization: Bearer $MIRIDIA_TOKEN" \
  -H "X-Business-Id: $MIRIDIA_BUSINESS_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "string",
  "description": "string",
  "color": "string",
  "isEnabled": true,
  "memberUserIds": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ]
}'

Response

{
  "message": "string",
  "messages": [
    {
      "title": "string",
      "message": "string",
      "level": "Standard",
      "icon": "SyncAlert",
      "code": "string"
    }
  ],
  "data": {
    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "name": "string",
    "description": "string",
    "color": "string",
    "enabled": true,
    "members": [
      {}
    ],
    "dateCreated": "2026-09-29T08:00:00Z",
    "dateModified": "2026-09-29T08:00:00Z"
  },
  "statusCode": "OK",
  "canRead": true,
  "canEdit": true,
  "canDelete": true
}

Delete team

DELETE/api/v1/teams/{teamId}

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

Parameters

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

Response

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

Request

curl -X DELETE "https://api.miridia.io/api/v1/teams/{teamId}" \
  -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.

PrimitiveUserResponse

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

TeamResponse

Field	Type	Description
`id`	`string (uuid)`
`name`	`string`
`description`	`string`
`color`	`string`
`enabled`	`boolean`
`members`	`PrimitiveUserResponse[]`
`dateCreated`	`string (date-time)`
`dateModified`	`string (date-time)`

Roles

Manages the business roles and their permission matrices.

Employees

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