Get Current Organization

Typescript (SDK)

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.organizations.organizationsGet();

  console.log(result);
}

run();

import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.organizations.organizations_get()

    # Handle response
    print(res)

const options = {method: 'GET', headers: {'Syllable-API-Key': '<api-key>'}};

fetch('https://api.syllable.cloud/api/v1/organizations/', 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.syllable.cloud/api/v1/organizations/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Syllable-API-Key: <api-key>"
  ],
]);

$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.syllable.cloud/api/v1/organizations/"

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

	req.Header.Add("Syllable-API-Key", "<api-key>")

	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://api.syllable.cloud/api/v1/organizations/")

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

request = Net::HTTP::Get.new(url)
request["Syllable-API-Key"] = '<api-key>'

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

{
  "display_name": "My Great Org",
  "id": 1,
  "name": "<string>",
  "last_updated": "2023-11-07T05:31:56Z",
  "description": "An organization that does great things with agentic AI.",
  "domains": "mygreatorg.com,myothergreatorg.org",
  "saml_provider_id": "saml.syllablesso",
  "last_updated_comments": "Updated to add an additional domain",
  "slug": "my-great-org",
  "last_updated_by": "<string>",
  "logo_url": "https://image.png"
}

GET

api

organizations

Typescript (SDK)

import { SyllableSDK } from "syllable-sdk";

const syllableSDK = new SyllableSDK({
  apiKeyHeader: process.env["SYLLABLESDK_API_KEY_HEADER"] ?? "",
});

async function run() {
  const result = await syllableSDK.organizations.organizationsGet();

  console.log(result);
}

run();

import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.organizations.organizations_get()

    # Handle response
    print(res)

const options = {method: 'GET', headers: {'Syllable-API-Key': '<api-key>'}};

fetch('https://api.syllable.cloud/api/v1/organizations/', 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.syllable.cloud/api/v1/organizations/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Syllable-API-Key: <api-key>"
  ],
]);

$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.syllable.cloud/api/v1/organizations/"

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

	req.Header.Add("Syllable-API-Key", "<api-key>")

	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://api.syllable.cloud/api/v1/organizations/")

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

request = Net::HTTP::Get.new(url)
request["Syllable-API-Key"] = '<api-key>'

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

{
  "display_name": "My Great Org",
  "id": 1,
  "name": "<string>",
  "last_updated": "2023-11-07T05:31:56Z",
  "description": "An organization that does great things with agentic AI.",
  "domains": "mygreatorg.com,myothergreatorg.org",
  "saml_provider_id": "saml.syllablesso",
  "last_updated_comments": "Updated to add an additional domain",
  "slug": "my-great-org",
  "last_updated_by": "<string>",
  "logo_url": "https://image.png"
}

Authorizations

Syllable-API-Key

string

header

required

Response

200 - application/json

Successful Response

display_name

string

required

The human-readable display name of the organization.

Example:

"My Great Org"

integer

required

The internal ID of the organization.

Example:

1

name

string

required

Unique, non-human-readable hash for the organization

last_updated

string<date-time>

required

The timestamp of the most recent update to the organization

description

string | null

Description of the organization.

Example:

"An organization that does great things with agentic AI."

domains

string | null

Comma-delimited list of domains that users at the organization may have in their email addresses.

Example:

"mygreatorg.com,myothergreatorg.org"

saml_provider_id

string | null

SAML provider ID for user authentication

Example:

"saml.syllablesso"

last_updated_comments

string | null

Comments for the most recent edit to the organization.

Example:

"Updated to add an additional domain"

slug

string | null

The slug of the organization used for URLs in the Console UI. Null until slug backfill has been run.

Example:

"my-great-org"

last_updated_by

string | null

The email of the user who most recently updated the organization

logo_url

string | null

CDN URL. The org will always have a logo, but this value will be null on a response to an update where no logo was provided on the request

Example:

"https://image.png"