List all Tenants - re.alto Docs

API Reference

Core Resources

Entities
Collectives
Tenants
- The Tenant object
- GET
  Retrieve a Tenant
- GET
  List all Tenants
- PATCH
  Update a Tenant
- GET
  List all Collectives by Tenant
- Members
- Administrators

Onboarding API

Entity Onboarding
Collective Onboarding
Guided Onboarding

Readings API

Readings
Aggregations

Commands API

Charge Sessions API

GET
List all Charge Sessions

Entity Settings

Features
Locations
Battery Capacity
Heated Area
Disaggregators
Custom Properties

Offboarding API

Offboard Entities

GET

tenants

curl --request GET \
  --url https://platform.realto.io/api/v1/tenants \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "administrators": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "entities": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ],
  "links": {
    "next": "<string>"
  },
  "meta": {
    "continuationToken": "<string>",
    "pageSize": 123
  }
}

Authorizations

Authorization

string

header

required

Access Token Authentication

Query Parameters

pageSize

integer

default:

The number of Tenants per page

continuationToken

string

The token used to retrieve the next page

Response

200

application/json

A page of Tenants

data

object[] | null

links

object

meta

object

Was this page helpful?

Retrieve a Tenant Update a Tenant

curl --request GET \
  --url https://platform.realto.io/api/v1/tenants \
  --header 'Authorization: Bearer <token>'

{
  "data": [
    {
      "administrators": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "entities": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>"
    }
  ],
  "links": {
    "next": "<string>"
  },
  "meta": {
    "continuationToken": "<string>",
    "pageSize": 123
  }
}