Get Organization
curl --request GET \
--url https://api.bunship.com/api/v1/organizations/{orgId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.bunship.com/api/v1/organizations/{orgId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.bunship.com/api/v1/organizations/{orgId}', 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.bunship.com/api/v1/organizations/{orgId}",
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.bunship.com/api/v1/organizations/{orgId}"
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.bunship.com/api/v1/organizations/{orgId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bunship.com/api/v1/organizations/{orgId}")
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{
"id": "org_cld2abc123def456",
"name": "Acme Corp",
"slug": "acme-corp",
"description": "Building the future of widgets",
"logoUrl": "https://cdn.bunship.com/logos/acme.png",
"settings": {
"branding": {
"primaryColor": "#5046E5"
},
"features": {
"webhooks": true,
"apiAccess": true
}
},
"createdBy": "usr_cld2abc123def456",
"createdAt": "2024-01-15T10:00:00Z",
"updatedAt": "2024-01-20T14:30:00Z"
}
Organizations
Get Organization
Get details of a specific organization
GET
/
api
/
v1
/
organizations
/
{orgId}
Get Organization
curl --request GET \
--url https://api.bunship.com/api/v1/organizations/{orgId} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.bunship.com/api/v1/organizations/{orgId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.bunship.com/api/v1/organizations/{orgId}', 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.bunship.com/api/v1/organizations/{orgId}",
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.bunship.com/api/v1/organizations/{orgId}"
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.bunship.com/api/v1/organizations/{orgId}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bunship.com/api/v1/organizations/{orgId}")
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{
"id": "org_cld2abc123def456",
"name": "Acme Corp",
"slug": "acme-corp",
"description": "Building the future of widgets",
"logoUrl": "https://cdn.bunship.com/logos/acme.png",
"settings": {
"branding": {
"primaryColor": "#5046E5"
},
"features": {
"webhooks": true,
"apiAccess": true
}
},
"createdBy": "usr_cld2abc123def456",
"createdAt": "2024-01-15T10:00:00Z",
"updatedAt": "2024-01-20T14:30:00Z"
}
Returns the full details of an organization. The authenticated user must be a member of the organization.
Auth
Requires a valid Bearer token. User must be a member of the organization.
Path Parameters
string
required
Organization identifier.
Response
string
Organization identifier.
string
Organization name.
string
URL slug.
string | null
Description.
string | null
Logo URL.
object
Organization settings including branding, features, and billing configuration.
string
User ID of the creator.
string
ISO 8601 creation timestamp.
string
ISO 8601 last update timestamp.
{
"id": "org_cld2abc123def456",
"name": "Acme Corp",
"slug": "acme-corp",
"description": "Building the future of widgets",
"logoUrl": "https://cdn.bunship.com/logos/acme.png",
"settings": {
"branding": {
"primaryColor": "#5046E5"
},
"features": {
"webhooks": true,
"apiAccess": true
}
},
"createdBy": "usr_cld2abc123def456",
"createdAt": "2024-01-15T10:00:00Z",
"updatedAt": "2024-01-20T14:30:00Z"
}
Errors
| Status | Code | Description |
|---|---|---|
401 | AUTHENTICATION_ERROR | Missing or invalid Bearer token |
403 | AUTHORIZATION_ERROR | User is not a member of this organization |
404 | NOT_FOUND | Organization not found |
Example
curl https://api.bunship.com/api/v1/organizations/org_cld2abc123def456 \
-H "Authorization: Bearer eyJhbGciOiJIUzI1NiIs..."

