Pular para o conteúdo principal
GET
/
v1
/
organizations
/
{organization_id}
/
tenants
Listar locatários
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>"
  }
}

Autorizações

​
Authorization
string
header
obrigatório

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

Parâmetros de caminho

​
organization_id
string
obrigatório

O identificador único da organização

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

Parâmetros de consulta

​
page
integer
padrão:1

Número da página (padrão: 1)

Intervalo obrigatório: x >= 1
​
per_page
integer
padrão:100

Número de itens por página

Intervalo obrigatório: 1 <= x <= 100
​
sort
string

Campo de ordenação com sufixo opcional de ordem (:asc ou :desc), e.g., "name", "name:asc", "create_date:desc". Use ordem ascendente por padrão se não houver sufixo. Campos válidos: id, create_date, name, region, product_id, policy_id

​
fields
string

Lista separada por vírgulas de campos a incluir em cada elemento do tenant. Campos selecionáveis: id, organization_id, create_date, name, region, product_id, policy_id. O campo id sempre é incluído.

Maximum string length: 2048
​
filters
string

Filtra tenants por um ou mais critérios. Fornece um objeto JSON com condições de filtro. Pode filtrar por qualquer campo retornado na resposta. Use operadores de comparação (eq, ne, gt, gte, lt, lte, in, nin, contains, startsWith, endsWith, between) e combine várias condições com operadores lógicos (and, or). Comprimento máximo: 5120 caracteres. Filtra tenants usando um objeto JSON. Especifica o campo a filtrar, o operador de comparação e o valor. Exemplo: {"field": "name", "op": "eq", "value": "Tenant 1"}

Maximum string length: 5120
Exemplo:

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

Resposta

Lista paginada de tenants recuperada com sucesso. A resposta inclui a bandeira de paginação e o array de dados de tenants.

​
has_next
boolean
obrigatório

Indica se há mais páginas disponíveis

​
data
object[]
obrigatório