GET
/
api
/
v1
/
organizations
/
Python (SDK)
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)
{
  "display_name": "My Great Org",
  "description": "An organization that does great things with agentic AI.",
  "domains": "mygreatorg.com,myothergreatorg.org",
  "saml_provider_id": "saml.syllablesso",
  "id": 1,
  "last_updated_comments": "Updated to add an additional domain",
  "slug": "my-great-org",
  "last_updated": "2023-11-07T05:31:56Z",
  "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.

Examples:

"My Great Org"

​
id
integer
required

The internal ID of the organization.

Examples:

1

​
slug
string
required

The slug of the organization used for URLs in the Console UI

Examples:

"my-great-org"

​
last_updated
string<date-time>
required

The timestamp of the most recent update to the organization

​
description
string | null

Description of the organization.

Examples:

"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.

Examples:

"mygreatorg.com,myothergreatorg.org"

​
saml_provider_id
string | null

SAML provider ID for user authentication

Examples:

"saml.syllablesso"

​
last_updated_comments
string | null

Comments for the most recent edit to the organization.

Examples:

"Updated to add an additional domain"

​
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

Examples:

"https://image.png"