API docs by Redocly

Speciality API (1.0.0)

Download OpenAPI specification:Download

API for managing specialities

Speciality

Speciality management operations

Get all specialities

Retrieve a list of all specialities with optional filtering and pagination

Authorizations:
ApiKeyAuth
query Parameters
page
integer >= 1
Default: 1

Page number for pagination

per_page
integer [ 1 .. 100 ]
Default: 25

Number of items per page

sort
string

Sort field

company_namespace
Array of strings

Company namespace for filtering

disabled
boolean

Filter by disabled status

_id
Array of strings

Filter by ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": [
    ],
  • "paging": {
    }
}

Create a new speciality

Create a new speciality entry

Authorizations:
ApiKeyAuth
Request Body schema: application/json
name
required
string

Speciality name

company_namespace
Array of strings

Company namespace

disabled
boolean
Default: false

Whether the speciality is disabled

Responses

Request samples

Content type
application/json
{
  • "name": "Cardiology",
  • "company_namespace": [
    ],
  • "disabled": false
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Get speciality by ID

Retrieve a specific speciality by its ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Speciality ID

Responses

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Update speciality

Update an existing speciality

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Speciality ID

Request Body schema: application/json
name
string

Speciality name

company_namespace
Array of strings

Company namespace

disabled
boolean

Whether the speciality is disabled

Responses

Request samples

Content type
application/json
{
  • "name": "Cardiology",
  • "company_namespace": [
    ],
  • "disabled": true
}

Response samples

Content type
application/json
{
  • "success": true,
  • "data": {
    }
}

Delete speciality

Delete a speciality by ID

Authorizations:
ApiKeyAuth
path Parameters
id
required
string

Speciality ID

Responses

Response samples

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

Bulk delete specialities

Delete multiple specialities by their IDs

Authorizations:
ApiKeyAuth
Request Body schema: application/json
ids
required
Array of strings

Array of speciality IDs to delete

Responses

Request samples

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

Response samples

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