Skip to content
SENS Platform Docs

List tenants visible to the authenticated actor.

GET
/v1/tenants
curl --request GET \
  --url 'https://api.dev.iot-sens.schlossers.at/v1/tenants?status=active&limit=25' \
  --header 'Authorization: Bearer <token>'

Returns Tenants in stable ascending creation order with the Tenant ID as a unique tie-breaker. Items and totalCount use the same search, status, and authorization predicates in one database snapshot. A cursor is bound to the caller, filters, and page size. Malformed, stale, oversized, or query-incompatible cursors fail with VALIDATION_FAILED.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

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: 25
Allowed values: 25 50 100

Responses

Section titled “Responses”

200

Section titled “200”

Stable tenant cursor page.

Media typeapplication/json
object
items
required
Array<object>
object
tenantId
required
string format: uuid
tenantNumber
required
integer format: int32
>= 1 <= 2147483647
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
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
totalCount
required
integer
Example
{
  "items": [
    {
      "status": "active"
    }
  ]
}

400

Section titled “400”

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

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