Get Organization Details

curl --request GET \
  --url https://{env}.tartanhq.com/api/org_details/{org}/

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{env}.tartanhq.com/api/org_details/{org}/",
  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://{env}.tartanhq.com/api/org_details/{org}/"

	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://{env}.tartanhq.com/api/org_details/{org}/")

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

{
  "id": 1469,
  "application": {
    "app_name": "default_connector_app",
    "app_key": "CELPZEWN",
    "app_secret": "RQUAAMBH"
  },
  "uuid": "82bbbbdb-b64c-47b9-8cb7-1b377b0dd906",
  "org_name": "Himanshu1999 kjytrtyui",
  "org_cin": null,
  "website_url": "",
  "logo_url": "https://tartan-assets.s3.ap-south-1.amazonaws.com/assets/files/tartan-node/Blanklogo.png",
  "email_domain": null,
  "invite_status": "accepted",
  "created_on": "2024-08-16T07:17:13.743Z",
  "modified_on": "2024-08-16T07:17:40.685Z",
  "is_client": true,
  "is_vendor": false,
  "brand_name": null,
  "remote_org_id": null,
  "hrms": null,
  "invited_by": 751,
  "created_by": 978
}

{
  "requestId": "0b47c238-7da1-4091-8a8e-8da1a91eae01",
  "message": "Not found.",
  "data": null
}

{
  "requestId": "be2915d5-fc30-4d13-bcca-3d62aefac2a0",
  "message": "Internal Server Error",
  "data": null
}

GET

api

org_details

{org}

Get Organization Details

curl --request GET \
  --url https://{env}.tartanhq.com/api/org_details/{org}/

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{env}.tartanhq.com/api/org_details/{org}/",
  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://{env}.tartanhq.com/api/org_details/{org}/"

	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://{env}.tartanhq.com/api/org_details/{org}/")

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

{
  "id": 1469,
  "application": {
    "app_name": "default_connector_app",
    "app_key": "CELPZEWN",
    "app_secret": "RQUAAMBH"
  },
  "uuid": "82bbbbdb-b64c-47b9-8cb7-1b377b0dd906",
  "org_name": "Himanshu1999 kjytrtyui",
  "org_cin": null,
  "website_url": "",
  "logo_url": "https://tartan-assets.s3.ap-south-1.amazonaws.com/assets/files/tartan-node/Blanklogo.png",
  "email_domain": null,
  "invite_status": "accepted",
  "created_on": "2024-08-16T07:17:13.743Z",
  "modified_on": "2024-08-16T07:17:40.685Z",
  "is_client": true,
  "is_vendor": false,
  "brand_name": null,
  "remote_org_id": null,
  "hrms": null,
  "invited_by": 751,
  "created_by": 978
}

{
  "requestId": "0b47c238-7da1-4091-8a8e-8da1a91eae01",
  "message": "Not found.",
  "data": null
}

{
  "requestId": "be2915d5-fc30-4d13-bcca-3d62aefac2a0",
  "message": "Internal Server Error",
  "data": null
}

Path Parameters

org

string

required

Unique identifier of the organization.

Response

Organization details retrieved successfully

integer

Example:

1469

application

object

Show child attributes

uuid

string<uuid>

Example:

"82bbbbdb-b64c-47b9-8cb7-1b377b0dd906"

org_name

string

Example:

"Himanshu1999 kjytrtyui"

org_cin

string | null

Example:

null

website_url

string

Example:

""

logo_url

string<uri>

Example:

"https://tartan-assets.s3.ap-south-1.amazonaws.com/assets/files/tartan-node/Blanklogo.png"

email_domain

string | null

Example:

null

invite_status

string

Example:

"accepted"

created_on

string<date-time>

Example:

"2024-08-16T07:17:13.743Z"

modified_on

string<date-time>

Example:

"2024-08-16T07:17:40.685Z"

is_client

boolean

Example:

true

is_vendor

boolean

Example:

false

brand_name

string | null

Example:

null

remote_org_id

string | null

Example:

null

hrms

string | null

Example:

null

invited_by

integer

Example:

751

created_by

integer

Example:

978