List tenant membership grants and their history.

GET

/v1/tenants/{tenantNumber}/memberships

const url = 'https://api.dev.iot-sens.schlossers.at/v1/tenants/1/memberships?status=active&limit=25&role=tenant_admin';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

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

Returns an exact count for the same tenant authorization scope and filters as the page. Rows use stable ascending (createdAt, membershipId) order. Cursors are bound to the actor, authorization scope, filters, and page size.

Authorizations

AccessToken

Parameters

Path Parameters

tenantNumber

required

integer format: int32

>= 1 <= 2147483647

Query Parameters

status

string

Allowed values: active disabled

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

userId

string format: uuid

role

string

Allowed values: tenant_admin org_admin viewer

Responses

200

Stable membership cursor page.

application/json

object

items

required

Array<object>

object

membershipId

required

string format: uuid

tenantId

required

string format: uuid

userId

required

string format: uuid

organizationUnitId

required

One of:

string
null

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

userDisplayName

required

string

>= 1 characters <= 200 characters

userEmail

required

string format: email

organizationUnitName

required

One of:

string
null

string

>= 1 characters <= 200 characters

nextCursor

string

totalCount

required

integer

Example

{
  "items": [
    {
      "role": "tenant_admin",
      "status": "active"
    }
  ]
}

default

A safe platform error response.

application/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

Cache-Control

string

Allowed value: no-store