List operator tenants

curl --request GET \
  --url https://services-api.talqui.chat/v1/tenants

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://services-api.talqui.chat/v1/tenants",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://services-api.talqui.chat/v1/tenants"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://services-api.talqui.chat/v1/tenants")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": {
    "tenants": [
      {
        "createdAt": "2023-11-07T05:31:56Z",
        "organizationID": "<string>",
        "ownerID": "<string>",
        "tenantDescription": "<string>",
        "tenantID": "<string>",
        "tenantLogo": "<string>",
        "tenantMeta": {},
        "tenantName": "<string>",
        "tenantOperatorRoles": {
          "managers": [
            "<string>"
          ],
          "owners": [
            "<string>"
          ]
        },
        "tenantOperatorsIDs": [
          "<string>"
        ],
        "tenantWebsite": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdBy": "<string>",
        "lastSignInAt": "2023-11-07T05:31:56Z",
        "subscriptionID": "<string>",
        "tenantSettings": {},
        "updatedBy": "<string>"
      }
    ]
  },
  "meta": {
    "count": 123,
    "currentPage": 123,
    "hasMore": true,
    "perPage": 123,
    "totalCount": 123,
    "totalPages": 123
  }
}

{
  "data": {
    "tenants": [
      {
        "createdAt": "2023-11-07T05:31:56Z",
        "organizationID": "<string>",
        "ownerID": "<string>",
        "tenantDescription": "<string>",
        "tenantID": "<string>",
        "tenantLogo": "<string>",
        "tenantMeta": {},
        "tenantName": "<string>",
        "tenantOperatorRoles": {
          "managers": [
            "<string>"
          ],
          "owners": [
            "<string>"
          ]
        },
        "tenantOperatorsIDs": [
          "<string>"
        ],
        "tenantWebsite": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdBy": "<string>",
        "lastSignInAt": "2023-11-07T05:31:56Z",
        "subscriptionID": "<string>",
        "tenantSettings": {},
        "updatedBy": "<string>"
      }
    ]
  },
  "meta": {
    "count": 123,
    "currentPage": 123,
    "hasMore": true,
    "perPage": 123,
    "totalCount": 123,
    "totalPages": 123
  }
}

{
  "errors": [
    {
      "error": "MissingOperatorIDError",
      "error_code": 1063,
      "message": "operatorID is required.",
      "statusCode": 400
    }
  ]
}

{
  "errors": [
    {
      "error": "UnauthorizedError",
      "error_code": 1003,
      "message": "You are not authorized to perform this request.",
      "statusCode": 401
    }
  ]
}

{
  "errors": [
    {
      "error": "UnknownError",
      "error_code": 5999,
      "message": "For some unknown reason your request has not succeeded.",
      "statusCode": 500
    }
  ]
}

Tenants

List operator tenants

Lists every tenant the authenticated operator is a member of, with each tenant’s full settings — what backs the tenant switcher after login.

The result is scoped by the caller’s identity, which is also what decides which :tenantID the rest of the API will accept from them. Superusers are not exempt — they get the tenants they belong to, not every tenant on the platform.

search narrows the list by tenant name. With infiniteScroll=true the response is paginated (page/perPage), carries a meta block and returns HTTP 206 instead of 200 when more pages are available. Without it the full list is returned, as it always was.

GET

tenants

List operator tenants

curl --request GET \
  --url https://services-api.talqui.chat/v1/tenants

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://services-api.talqui.chat/v1/tenants",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$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://services-api.talqui.chat/v1/tenants"

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

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://services-api.talqui.chat/v1/tenants")

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

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "data": {
    "tenants": [
      {
        "createdAt": "2023-11-07T05:31:56Z",
        "organizationID": "<string>",
        "ownerID": "<string>",
        "tenantDescription": "<string>",
        "tenantID": "<string>",
        "tenantLogo": "<string>",
        "tenantMeta": {},
        "tenantName": "<string>",
        "tenantOperatorRoles": {
          "managers": [
            "<string>"
          ],
          "owners": [
            "<string>"
          ]
        },
        "tenantOperatorsIDs": [
          "<string>"
        ],
        "tenantWebsite": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdBy": "<string>",
        "lastSignInAt": "2023-11-07T05:31:56Z",
        "subscriptionID": "<string>",
        "tenantSettings": {},
        "updatedBy": "<string>"
      }
    ]
  },
  "meta": {
    "count": 123,
    "currentPage": 123,
    "hasMore": true,
    "perPage": 123,
    "totalCount": 123,
    "totalPages": 123
  }
}

{
  "data": {
    "tenants": [
      {
        "createdAt": "2023-11-07T05:31:56Z",
        "organizationID": "<string>",
        "ownerID": "<string>",
        "tenantDescription": "<string>",
        "tenantID": "<string>",
        "tenantLogo": "<string>",
        "tenantMeta": {},
        "tenantName": "<string>",
        "tenantOperatorRoles": {
          "managers": [
            "<string>"
          ],
          "owners": [
            "<string>"
          ]
        },
        "tenantOperatorsIDs": [
          "<string>"
        ],
        "tenantWebsite": "<string>",
        "updatedAt": "2023-11-07T05:31:56Z",
        "createdBy": "<string>",
        "lastSignInAt": "2023-11-07T05:31:56Z",
        "subscriptionID": "<string>",
        "tenantSettings": {},
        "updatedBy": "<string>"
      }
    ]
  },
  "meta": {
    "count": 123,
    "currentPage": 123,
    "hasMore": true,
    "perPage": 123,
    "totalCount": 123,
    "totalPages": 123
  }
}

{
  "errors": [
    {
      "error": "MissingOperatorIDError",
      "error_code": 1063,
      "message": "operatorID is required.",
      "statusCode": 400
    }
  ]
}

{
  "errors": [
    {
      "error": "UnauthorizedError",
      "error_code": 1003,
      "message": "You are not authorized to perform this request.",
      "statusCode": 401
    }
  ]
}

{
  "errors": [
    {
      "error": "UnknownError",
      "error_code": 5999,
      "message": "For some unknown reason your request has not succeeded.",
      "statusCode": 500
    }
  ]
}

Query Parameters

string

Case-insensitive match against the tenant name.

Required string length: 1 - 120

infiniteScroll

enum<string>

default:false

true returns one page plus meta; false (default) returns every matching tenant.

Available options:

true,

false

page

integer

default:1

1-indexed page number. Only read when infiniteScroll=true.

Required range: 1 <= x <= 9007199254740991

perPage

integer

default:10

Tenants per page (max 50). Only read when infiniteScroll=true.

Required range: 1 <= x <= 50

Response

Response for status 200.

data

object

required

Show child attributes

Real Time API

Services API

Helpdesk API

List operator tenants

Query Parameters

Response