Skip to main content
GET
/
orgs
/
{org_id}
Get Organization
curl --request GET \
  --url https://api.yertle.com/orgs/{org_id}
{
  "id": "<string>",
  "name": "<string>",
  "public_id": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "invite_mode": "<string>",
  "is_public": false,
  "role": "owner",
  "member_count": 123,
  "node_count": 123,
  "root_node_id": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.yertle.com/llms.txt

Use this file to discover all available pages before exploring further.

Headers

​
authorization
string | null

Path Parameters

​
org_id
string
required

Response

Successful Response

Response model for organization data.

​
id
string
required

Organization ID

​
name
string
required

Organization name

​
public_id
string
required

URL-friendly public identifier

​
created_at
string<date-time>
required

Creation timestamp

​
updated_at
string<date-time>
required

Last update timestamp

​
description
string | null

Organization description

​
invite_mode
string | null

Invite mode (open or restricted)

​
is_public
boolean
default:false

Whether the org is published for anonymous read

​
role
enum<string> | null

Current user's role

Available options:
owner,
editor,
viewer
​
member_count
integer | null

Number of members

​
node_count
integer | null

Number of nodes

​
root_node_id
string | null

ID of the organization's root node