Skip to content
SENS Platform Docs

List all accessible organization units and navigation ancestors.

GET
/v1/tenants/{tenantNumber}/organization-units
curl --request GET \
  --url 'https://api.dev.iot-sens.schlossers.at/v1/tenants/1/organization-units?status=active&limit=50' \
  --header 'Authorization: Bearer <token>'

Compatibility collection ordered by createdAt and organizationUnitId. The API defaults to 50 rows. Its opaque cursor is bound to the actor, current platform roles and memberships, Tenant, normalized search, status filter, and page size. Changed inputs or a missing cursor position fail with VALIDATION_FAILED.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
tenantNumber
required
integer format: int32
>= 1 <= 2147483647

Query Parameters

Section titled “Query Parameters”
status
string
Allowed values: active disabled
q
string
<= 100 characters
cursor
string
<= 512 characters

Opaque continuation token; reuse the original filters and scope.

limit
integer
default: 50 >= 1 <= 100

Responses

Section titled “Responses”

200

Section titled “200”

Stable organization-unit cursor page.

Media typeapplication/json
object
items
required
Array<object>
object
organizationUnitId
required
string format: uuid
tenantId
required
string format: uuid
parentOrganizationUnitId
required
One of:
string format: uuid
key
required
string
/^[a-z0-9][a-z0-9_-]{0,63}$/
name
required
string
>= 1 characters <= 200 characters
status
required
string
Allowed values: active disabled
effectiveStatus
required
string
Allowed values: active disabled
scopeRelation
required
string
Allowed values: accessible ancestor
hasChildren
required

Whether at least one direct child is visible to the current actor.

boolean
metadata
required
object
<= 50 properties
key
additional properties
One of:
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
nextCursor
string
Example
{
  "items": [
    {
      "status": "active",
      "effectiveStatus": "active",
      "scopeRelation": "accessible"
    }
  ]
}

default

Section titled “default”

A safe platform error response.

Media typeapplication/json
object
error
required
object
code
required
string
Allowed values: VALIDATION_FAILED AUTHENTICATION_FAILED AUTHORIZATION_FAILED RESOURCE_NOT_FOUND CONFLICT DEPENDENCY_FAILURE FLOW_FAILURE RATE_LIMITED INTERNAL_ERROR
category
required
string
Allowed values: validation authentication authorization not_found conflict dependency_failure flow_failure rate_limit internal
message
required

Safe client-facing diagnostic message.

string
correlationId
required

Correlation ID for operational investigation.

string
>= 1 characters
details

Safe bounded diagnostic details.

object
key
additional properties
One of:
string
Example
{
  "error": {
    "code": "VALIDATION_FAILED",
    "category": "validation"
  }
}

Headers

Section titled “Headers”
Cache-Control
string
Allowed value: no-store