Organization

Get Organization

Returns the organization structure the caller belongs to.

Notes:

When the caller is part of a multi-team group (brokerage), orgType is MULTI_TEAM and multiTeamInfo carries the parent group’s ID and name; enterpriseInfo is absent.
Otherwise orgType is SIGNAL_INSTANCE and enterpriseInfo describes the caller’s office, visible sub-offices, and assigned permission profile.
visibleOrgInfoList depends on the caller’s permissions: callers with MANAGE_ORGANIZATION see all offices in the company; callers with MANAGE_ORGANIZATION_DEPARTMENT see their own office’s sub-offices; others receive an empty list.

GET

v1.0

org

Get Organization

curl --request GET \
  --url https://api.lofty.com/v1.0/org \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.lofty.com/v1.0/org"

headers = {"Authorization": "<authorization>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.lofty.com/v1.0/org', 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.lofty.com/v1.0/org",
  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: <authorization>"
  ],
]);

$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.lofty.com/v1.0/org"

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

	req.Header.Add("Authorization", "<authorization>")

	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.lofty.com/v1.0/org")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lofty.com/v1.0/org")

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

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

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

{
  "orgType": 123,
  "enterpriseInfo": {
    "groupId": 123,
    "groupName": "<string>",
    "profileId": 123,
    "profileName": "<string>",
    "visibleOrgInfoList": [
      {
        "groupId": 123,
        "groupName": "<string>",
        "parentId": 123
      }
    ]
  },
  "multiTeamInfo": {
    "multiTeamId": 123,
    "multiTeamName": "<string>"
  }
}

"<string>"

"<string>"

Headers

Authorization

string

required

Bearer [access_token]

Response

Organization info for the caller.

orgType

integer<int64>

Organization type

enterpriseInfo

object

If the client is on the "Enterprise Package," the enterprise organization structure will be returned. Refer to "EnterpriseInfo."

Show child attributes

multiTeamInfo

object

If the client is on the "Multi-Team Package," the Multi-Team info will be returned.

Show child attributes

Add tags to an agent

Add Office

Get Organization

curl --request GET \
  --url https://api.lofty.com/v1.0/org \
  --header 'Authorization: <authorization>'

import requests

url = "https://api.lofty.com/v1.0/org"

headers = {"Authorization": "<authorization>"}

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

print(response.text)

const options = {method: 'GET', headers: {Authorization: '<authorization>'}};

fetch('https://api.lofty.com/v1.0/org', 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.lofty.com/v1.0/org",
  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: <authorization>"
  ],
]);

$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.lofty.com/v1.0/org"

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

	req.Header.Add("Authorization", "<authorization>")

	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.lofty.com/v1.0/org")
  .header("Authorization", "<authorization>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.lofty.com/v1.0/org")

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

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

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

{
  "orgType": 123,
  "enterpriseInfo": {
    "groupId": 123,
    "groupName": "<string>",
    "profileId": 123,
    "profileName": "<string>",
    "visibleOrgInfoList": [
      {
        "groupId": 123,
        "groupName": "<string>",
        "parentId": 123
      }
    ]
  },
  "multiTeamInfo": {
    "multiTeamId": 123,
    "multiTeamName": "<string>"
  }
}

"<string>"

"<string>"

Leads

Task & Calendar

Transactions

Listings

Communication

Team

AI Copilot

Webhooks

Integrations

Get Organization

Headers

Response