Saltar al contingut principal
GET
/
v1
/
organizations
/
{organization_id}
/
tenants
Llistar arrendataris
curl --request GET \
  --url https://api.flexxible.net/v1/organizations/{organization_id}/tenants \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://api.flexxible.net/v1/organizations/{organization_id}/tenants"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.flexxible.net/v1/organizations/{organization_id}/tenants', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.flexxible.net/v1/organizations/{organization_id}/tenants",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.flexxible.net/v1/organizations/{organization_id}/tenants"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.get("https://api.flexxible.net/v1/organizations/{organization_id}/tenants")
  .header("Authorization", "Bearer <token>")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.flexxible.net/v1/organizations/{organization_id}/tenants")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "has_next": true,
  "data": [
    {
      "id": "<string>",
      "organization_id": "<string>",
      "create_date": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "region": "<string>",
      "product_id": "<string>",
      "policy_id": "<string>"
    }
  ]
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}
{
  "error": {
    "message": "<string>",
    "code": "<string>",
    "details": "<string>"
  }
}

Autoritzacions

​
Authorization
string
header
requerit

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paràmetres de ruta

​
organization_id
string
requerit

El identificador únic de l'organització

Maximum string length: 24
Pattern: ^[0-9a-f]{24}$

Paràmetres de consulta

​
page
integer
predeterminat:1

Número de pàgina (predeterminat: 1)

Rang requerit: x >= 1
​
per_page
integer
predeterminat:100

Número d'elements per pàgina

Rang requerit: 1 <= x <= 100
​
sort
string

Camp de ordenació amb sufix opcional d'ordre (:asc o :desc), p. ex., "name", "name:asc", "create_date:desc". Usa ordre ascendent per defecte si no es proporciona sufix. Camps vàlids: id, create_date, name, region, product_id, policy_id

​
fields
string

Llista separada per comes de camps a incloure en cada element de tenant. Camps seleccionables: id, organization_id, create_date, name, region, product_id, policy_id. El camp id sempre s'inclou.

Maximum string length: 2048
​
filters
string

Filtra tenants per un o més criteris. Proporciona un objecte JSON amb condicions de filtratge. Pots filtrar per qualsevol camp retornat en la resposta. Usa operadors de comparació (eq, ne, gt, gte, lt, lte, in, nin, contains, startsWith, endsWith, between) i combina diverses condicions amb operadors lògics (and, or). Longitud màxima: 5120 caràcters. Filtra tenants usant un objecte JSON. Especifica el camp a filtrar, l'operador de comparació i el valor. Exemple: {"field": "name", "op": "eq", "value": "Tenant 1"}

Maximum string length: 5120
Exemple:

"{\"field\": \"name\", \"op\": \"eq\", \"value\": \"Tenant 1\"}"

Resposta

Llista paginada de tenants recuperada correctament. La resposta inclou la bandera de paginació i l'arranjament de dades de tenants.

​
has_next
boolean
requerit

Indica si hi ha més pàgines disponibles

​
data
object[]
requerit