Skip to main content
This guide walks you through authenticating, listing your organizations, and reading a node from the Yertle API.

​
1. Get an account

Sign up at yertle.com and create or join an organization.

​
2. Generate a Personal Access Token

Sign in to yertle.com, open your settings page, and under Personal Access Tokens click Create token. Give it a descriptive name (e.g. “quickstart laptop”) and copy the token — it starts with yrt_ and you’ll only see it once. Export it:
To have the Yertle CLI store the token for you instead, see the Authentication guide.

​
3. Make your first API call

List the organizations you belong to:
You should see a JSON response with your orgs:

​
4. Read a node

Pick an org ID and a node ID from your workspace, then fetch the complete state:
This returns the full node with parents, children, connections, tags, directories, and visual properties.

​
Prefer Python?

Install the SDK into your project — same three-line quickstart in code:
uv add works inside a uv project; run uv init first if you don’t have one.

​
Next steps

Core Concepts

Understand the Git-like model behind the API.

API Reference

Browse every endpoint.