Get an organization

Returns a single organization you manage, including its claim status and projects.

GET /partner/orgs/{orgId}

Get an organization

cURL

curl --request GET \
  --url https://api.onecli.sh/v1/partner/orgs/{orgId} \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.onecli.sh/v1/partner/orgs/{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.onecli.sh/v1/partner/orgs/{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.onecli.sh/v1/partner/orgs/{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.onecli.sh/v1/partner/orgs/{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.onecli.sh/v1/partner/orgs/{orgId}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.onecli.sh/v1/partner/orgs/{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

200

{
  "id": "<string>",
  "name": "<string>",
  "slug": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "claimedByEmail": "<string>",
  "claimedAt": "2023-11-07T05:31:56Z",
  "projects": [
    {
      "id": "<string>",
      "name": "<string>",
      "slug": "<string>",
      "createdAt": "2023-11-07T05:31:56Z"
    }
  ]
}

{
  "error": "<string>"
}

Authorizations

Authorization · string · header · required

API key obtained from the dashboard or GET /user/api-key

Path Parameters

orgId · string · required

Response

200

application/json

Organization

id · string

name · string

slug · string

createdAt · string<date-time>

status · enum<string>

Whether the organization has been claimed by a customer, or detached from the partner.

Available options: unclaimed, claimed, detached

claimedByEmail · string | null

Email of the customer who claimed the organization, if claimed.

claimedAt · string<date-time> | null

projects · object[]

Show child attributes