Get Department list

This operation retrieves all the departments. (For now, departments can only be created from the UI.)

SecuritybearerAuth
Request
query Parameters
skip
integer

Number of records to skip from the start of the result set. Used for pagination. Default is 0.

Example: skip=0
limit
integer

Maximum number of records to return in the response. Used for pagination.

Example: limit=20
locationId
string

Filters departments by the specified location ID.

departmentId
string

Retrieves department details for the specified department ID.

Responses
200

The Department list has been retrived successfully.

400

Invalid request.

401

The request could not be authorized.

404

The requested resource was not found.

500

The request could not be completed due to an internal error.

get/api/v1/departments
Request samples 
Response samples 
application/json
{
  • "pageInfo": {
    },
  • "departments": [
    ]
}