org.designtxt.getTokens

bomberstudios.com

Documentation

Retrieve design tokens from a tokenCollection record. If no input modifiers are provided, returns the raw token document. If an input object is given (matching a resolver document's modifiers), tokens are resolved against that context.

main query

Retrieve design tokens from a tokenCollection record. If no input modifiers are provided, returns the raw token document. If an input object is given (matching a resolver document's modifiers), tokens are resolved against that context.

Parameters

path string Optional

JSON Pointer path to a specific subtree within the token collection. When set, only the sub-tree at this path is returned.

ref string at-uri Required

AT-URI of the org.designtxt.tokenCollection record to retrieve.

resolveReferences boolean Optional

If true, resolve alias references ({token.name}) inline in the response. Defaults to false.

Output

Encodingapplication/json
resolvedAt stringdatetime Optional

Timestamp when the response was produced.

tokens unknown Required

The requested token data. Either the full token collection, the subtree at the requested path, or the resolved token values.

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://api.bsky.social)
Parameters
JSON Pointer path to a specific subtree within the token collection. When set, only the sub-tree at this path is returned.
AT-URI of the org.designtxt.tokenCollection record to retrieve.
If true, resolve alias references ({token.name}) inline in the response. Defaults to false.
View raw schema 
{
  "type": "query",
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "tokens"
      ],
      "properties": {
        "tokens": {
          "type": "unknown",
          "description": "The requested token data. Either the full token collection, the subtree at the requested path, or the resolved token values."
        },
        "resolvedAt": {
          "type": "string",
          "format": "datetime",
          "maxLength": 64,
          "description": "Timestamp when the response was produced."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "ref"
    ],
    "properties": {
      "ref": {
        "type": "string",
        "format": "at-uri",
        "maxLength": 8192,
        "description": "AT-URI of the org.designtxt.tokenCollection record to retrieve."
      },
      "path": {
        "type": "string",
        "maxLength": 1024,
        "description": "JSON Pointer path to a specific subtree within the token collection. When set, only the sub-tree at this path is returned."
      },
      "resolveReferences": {
        "type": "boolean",
        "description": "If true, resolve alias references ({token.name}) inline in the response. Defaults to false."
      }
    }
  },
  "description": "Retrieve design tokens from a tokenCollection record. If no input modifiers are provided, returns the raw token document. If an input object is given (matching a resolver document's modifiers), tokens are resolved against that context."
}

Lexicon Garden

@