Skip to main content
GET
/
api
/
v2
/
external
/
orgs
/
{slug}
Get Org
curl --request GET \
  --url https://api.example.com/api/v2/external/orgs/{slug}
import requests

url = "https://api.example.com/api/v2/external/orgs/{slug}"

response = requests.get(url)

print(response.text)
const options = {method: 'GET'};

fetch('https://api.example.com/api/v2/external/orgs/{slug}', 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.example.com/api/v2/external/orgs/{slug}",
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://api.example.com/api/v2/external/orgs/{slug}"

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

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.example.com/api/v2/external/orgs/{slug}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v2/external/orgs/{slug}")

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
{
  "slug": "<string>",
  "name": "<string>",
  "id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "billing_email": "<string>",
  "billing_details": {
    "billing_company_name": "<string>",
    "billing_address_line1": "<string>",
    "billing_address_line2": "<string>",
    "billing_city": "<string>",
    "billing_state": "<string>",
    "billing_postal_code": "<string>",
    "billing_country": "<string>",
    "billing_tax_id": "<string>",
    "billing_tax_id_type": "<string>"
  }
}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}

Path Parameters

slug
string
required

Response

Successful Response

slug
string
required
Required string length: 1 - 64
Pattern: ^[a-z0-9][a-z0-9-]*$
name
string
required
Required string length: 1 - 100
id
string
required
created_at
string<date-time>
required
billing_email
string | null
billing_details
OrgBillingDetails · object | null

An org's company billing details (stored in org_billing_details, 1:1 with the org). Synced onto the Stripe customer at checkout so they render on the generated invoice (Bill to / VAT). All optional — an org with none set falls back to Stripe's default (customer email only).