Skip to content

List Units

GET
/units

Returns a paginated list of Units in the current Space. Supports search by name and sorting by name, resourceCount, or actionCount. Each item includes the count of assigned Resources and Actions.

page
number
default: 1 >= 1
Example
1

Page number (1-based)

limit
number
default: 20 >= 1 <= 100
Example
20

Items per page (max 100)

sortDir
string
Allowed values: asc desc
Example
asc

Sort direction

search
string
Example
production

Search by name (case-insensitive)

sortBy
string
Allowed values: name resourceCount actionCount
Example
name

Sort field

X-Space-Id
required
string format: uuid

UUID of the target Space (tenant boundary). Validated against user access.

object
data
required
Array<object>
object
id
required

Unit ID

string format: uuid
Example
550e8400-e29b-41d4-a716-446655440000
name
required

Unit name

string
Example
Production Department
resourceCount
required

Number of assigned resources

number
Example
12
actionCount
required

Number of assigned actions

number
Example
5
meta
required
object
page
required

Current page number

number
Example
1
limit
required

Items per page

number
Example
20
total
required

Total number of items

number
Example
42
totalPages
required

Total number of pages

number
Example
3

Unauthorized — missing or invalid JWT

Forbidden — insufficient permissions