Skip to content
SENS Platform Docs

List users with membership history in a tenant.

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

Returns an exact count for the same tenant authorization scope and filters as the page. Rows use stable ascending (createdAt, userId) order. Global roles and metadata are not exposed.

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

Responses

Section titled “Responses”

200

Section titled “200”

Tenant users without global role or metadata fields.

Media typeapplication/json
object
items
required
Array<object>
object
userId
required
string format: uuid
username
required
One of:
string
email
required
string format: email
displayName
required
string
status
required
string
Allowed values: active disabled
memberships
required
Array<object>
object
membershipId
required
string format: uuid
tenantId
required
string format: uuid
userId
required
string format: uuid
organizationUnitId
required
One of:
string format: uuid
role
required
string
Allowed values: tenant_admin org_admin viewer
includeDescendants
required
boolean
status
required
string
Allowed values: active disabled
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
nextCursor
string
totalCount
required
integer
Example
{
  "items": [
    {
      "status": "active",
      "memberships": [
        {
          "role": "tenant_admin",
          "status": "active"
        }
      ]
    }
  ]
}

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