Unified.to

https://docs.unified.to
Admin
Unified.to is an API platform that provides a single, unified API for integrating multiple services...
Tokens:4,865,591
Snippets:22,927
Trust Score:8.3
Update:1 week ago
Show doc for...
Tokens:
Raw
### Get started with Hubspot project

Source: https://docs.unified.to/guides/how_to_create_connection_with_hubspot.md

Starts a new Hubspot project. Run this in the same project directory after initializing.

```javascript
hs get-started
```

--------------------------------

### Set up project and install dependencies

Source: https://docs.unified.to/guides/ats_to_vector_db_how_to_power_talent_intelligence_with_real_time_data.md

Creates a new project directory, initializes npm, and installs the Unified.to TypeScript SDK, dotenv, and Pinecone client.

```bash
mkdir ats-vector-demo
cd ats-vector-demo
npm init -y
npm install @unified-api/typescript-sdk dotenv @pinecone-database/pinecone
```

--------------------------------

### GET request example

Source: https://docs.unified.to/concepts/glossary/response.md

Example HTTP GET request to retrieve a user's profile. Includes the request line, Host header, and Authorization header with a placeholder for the access token.

```http
GET /v2/user/123 HTTP/1.1
Host: api.example.com
Authorization: Bearer [ACCESS_TOKEN_GOES_HERE]

```

--------------------------------

### Clone and set up the tutorial repository

Source: https://docs.unified.to/tutorials/build-a-simple-javascript-app.md

Commands to clone the Unified.to JavaScript tutorial repository, navigate into it, and install dependencies. Run these in the folder where you want to download the repo. After running, the app should be available on localhost:1234.

```shell
// inside the folder where you want to download the repo
git clone git@github.com:unified-to/unified-javascript-tutorial.git
cd unified-javascript-tutorial
npm i

```

--------------------------------

### Set up project and install dependencies

Source: https://docs.unified.to/guides/how_to_build_an_e_commerce_product_integration_with_unified.md

Initializes a new Node.js project and installs the Unified TypeScript SDK and dotenv for environment variable management.

```bash
mkdir ecommerce-demo
cd ecommerce-demo
npm init -y
npm install @unified-api/typescript-sdk dotenv
```

--------------------------------

### GET invoice with raw field

Source: https://docs.unified.to/migrate/rutter

Example of using the raw field to get the platform's original record.

```http
GET /accounting/{connection_id}/invoice?fields=id,total_amount,status,raw

```

--------------------------------

### Get observation using Python requests

Source: https://docs.unified.to/healthcare/observation/Retrieve_an_observation.md

Python example using the requests library to GET the observation endpoint. Includes accept and authorization headers.

```python
import requests

url = "https://api.unified.to/healthcare/5de520f96e439b002043d8dc/observation/5de520f96e439b002043d8d8?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.get(url, headers=headers)
```

--------------------------------

### Set up MCP client with mcp-use

Source: https://docs.unified.to/guides/how_to_connect_llms_to_real_time_saas_data_with_unified_mcp_server.md

Initializes an MCPClient with a Unified MCP URL, lists available tools, and calls the first tool with no arguments. Requires CONNECTION_ID and API_KEY environment variables.

```python
# client.py
import os
import hashlib
import secrets
from dotenv import load_dotenv
from mcp_use import MCPClient

load_dotenv()

CONNECTION_ID = os.getenv("CONNECTION_ID")
TOKEN = os.getenv("API_KEY")

MCP_URL = f"<https://mcp-api.unified.to/mcp?token={TOKEN}&connection={CONNECTION_ID}>"

client = MCPClient(MCP_URL)

# List available tools
tools = client.list_tools()
print("Available tools:", [tool['id'] for tool in tools])

# Call a tool (example: call the first tool with no arguments)
if tools:
    tool_id = tools[0]['id']
    result = client.call_tool(tool_id, {})
    print("Tool result:", result)
```

--------------------------------

### Get observation using Go net/http

Source: https://docs.unified.to/healthcare/observation/Retrieve_an_observation.md

Go example using net/http to GET the observation endpoint. Sets accept and authorization headers Bernstein.

```go
import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/healthcare/5de520f96e439b002043d8dc/observation/5de520f96e439b002043d8d8?fields=&raw=

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

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
```

--------------------------------

### Upload and open project

Source: https://docs.unified.to/skills/hubspot-oauth-app/SKILL.md

Upload the project to create a build and register the app, then open the project to access the Auth tab.

```bash
hs project upload      # creates a build and registers the app
hs project open        # opens the project; click the app → Auth tab
```

--------------------------------

### cURL: GET /unified/issue/{id}

Source: https://docs.unified.to/unified/issue/Retrieve_support_issue.md

Uses cURL command-line tool to send a GET request to the Unified.to API. Requires an authorization header. The example uses --request GET and --url flags.

```bash
curl --request GET \
  --url 'https://api.unified.to/unified/issue/5de520f96e439b002043d8d8' \
  --header 'accept: application/json' \
  --header 'authorization: .....'
```

--------------------------------

### Set up project dependencies for mcp-use client

Source: https://docs.unified.to/guides/how_to_connect_llms_to_real_time_saas_data_with_unified_mcp_server.md

Run these commands to create a virtual environment and install required packages: mcp-use, python-dotenv, requests, and openai. This sets up the client project for connecting to Unified MCP.

```bash
mkdir unified-mcp-client
cd unified-mcp-client
python -m venv .venv
source .venv/bin/activate
pip install mcp-use python-dotenv requests openai
touch client.py
```

--------------------------------

### Java: GET /unified/issue/{id}

Source: https://docs.unified.to/unified/issue/Retrieve_support_issue.md

Uses AsyncHttpClient to perform a GET request to the Unified.to API. Requires an authorization header. The example prints the response to stdout.

```java
AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/unified/issue/5de520f96e439b002043d8d8")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();
```

--------------------------------

### Set up project and install dependencies

Source: https://docs.unified.to/guides/how_to_build_enterprise_search_using_rag.md

Initializes a new Node.js project and installs the required packages: dotenv and the Unified API TypeScript SDK.

```typescript
mkdir rag-bot
cd rag-bot
npm init -y
npm install dotenv @unified-api/typescript-sdk
```

--------------------------------

### cURL: GET bankfeedaccount

Source: https://docs.unified.to/accounting/bankfeedaccount/List_all_bankfeedaccounts.md

Uses cURL to send a GET request to the Unified.to API. Requires an authorization token. The example includes query parameters in the URL.

```bash
curl --request GET \
  --url 'https://api.unified.to/accounting/5de520f96e439b002043d8dc/bankfeedaccount?limit=50&offset=0&updated_gte=2026-10-12T15:50:22.095Z&sort=updated_at&order=asc&query=&org_id=&type=&fields=&raw=' \
  --header 'accept: application/json' \
  --header 'authorization: .....'
```

--------------------------------

### JSON response body example

Source: https://docs.unified.to/concepts/glossary/response.md

Example JSON response body for a successful GET request, containing user profile fields: id, name, email, and created_at.

```json
{
  "id":         "01234",
  "name":       "Jane Doe",
  "email":      "jane.doe@example.com",
  "created_at": "2024-05-25T12:34:56Z"
}

```

--------------------------------

### Example: sync a product catalog (fetch)

Source: https://docs.unified.to/skills/unified-ecommerce/SKILL.md

JavaScript example showing how to page through all products and create a product using the Unified Commerce API. Uses environment variable UNIFIED_API_KEY for authentication.

```javascript
const BASE = 'https://api.unified.to';
const headers = {
    Authorization: `Bearer ${process.env.UNIFIED_API_KEY}`,
    'Content-Type': 'application/json',
};

// Page through all products, newest first
async function* allItems(connectionId) {
    let offset = 0;
    const limit = 100;
    while (true) {
        const res = await fetch(
            `${BASE}/commerce/${connectionId}/item?limit=${limit}&offset=${offset}`,
            { headers }
        );
        const page = await res.json();
        yield* page;
        if (page.length < limit) break;
        offset += limit;
    }
}

// Create a product
await fetch(`${BASE}/commerce/${connectionId}/item`, {
    method: 'POST',
    headers,
    body: JSON.stringify({
        name: 'Classic Tee',
        description: '100% cotton',
        is_active: true,
    }),
});
```

--------------------------------

### Ruby: GET /unified/issue/{id}

Source: https://docs.unified.to/unified/issue/Retrieve_support_issue.md

Uses net/http with SSL to send a GET request to the Unified.to API. Requires an authorization header. The example prints the response body.

```ruby
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/unified/issue/5de520f96e439b002043d8d8")

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

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

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

--------------------------------

### Set Up Project Dependencies and Environment Variables

Source: https://docs.unified.to/guides/how_to_build_a_fintech_application_with_unified_payments_api.md

Initialize the project directory and install the Unified TypeScript SDK along with dotenv. Then create a .env file to store your Unified API key and your customer's Stripe connection ID.

```bash
mkdir payments-demo
cd payments-demo
npm init -y
npm install @unified-api/typescript-sdk dotenv
```

```plain text
UNIFIED_API_KEY=your_unified_api_key
CONNECTION_STRIPE=your_customer_stripe_connection_id
```

--------------------------------

### Go: GET /unified/issue/{id}

Source: https://docs.unified.to/unified/issue/Retrieve_support_issue.md

Uses net/http to send a GET request to the Unified.to API. Requires an authorization header. The example reads the response body with ioutil.ReadAll.

```go
import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/unified/issue/5de520f96e439b002043d8d8

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

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
```

--------------------------------

### Install Hubspot CLI and initialize

Source: https://docs.unified.to/guides/how_to_create_connection_with_hubspot.md

Installs the Hubspot CLI globally and initializes it. Run this in your IDE terminal.

```javascript
npm install -g @hubspot/cli && hs init
```

--------------------------------

### Example usage

Source: https://docs.unified.to/guides/how_to_use_user_provisioning_and_verification_with_unified.md

Demonstrates the full workflow: create a user, list users, update (deactivate) the user, and optionally list verification requests. Uses the connection IDs from environment variables.

```typescript
async function main() {
  // 1. Create a user
  const user = await createUser(CONNECTION_BAMBOOHR!, "jane.doe@example.com", "Jane", "Doe");

  // 2. List users
  const users = await listUsers(CONNECTION_BAMBOOHR!);

  // 3. Update (deactivate) user
  if (user?.id) {
    const updated = await updateUserStatus(CONNECTION_BAMBOOHR!, user.id, "INACTIVE");
    console.log("Updated user:", updated);
  }

  // 4. List verification requests (optional)
  if (CONNECTION_VERIFICATION) {
    const requests = await listVerificationRequests(CONNECTION_VERIFICATION!);
    console.log("Verification requests:", requests.length);
  }

  console.log("Users:", users.length);
}

main();
```

--------------------------------

### Java: GET bankfeedaccount with AsyncHttpClient

Source: https://docs.unified.to/accounting/bankfeedaccount/List_all_bankfeedaccounts.md

Uses AsyncHttpClient to send a GET request to the Unified.to API. Requires an authorization token. The example includes query parameters in the URL.

```java
AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/accounting/5de520f96e439b002043d8dc/bankfeedaccount?limit=50&offset=0&updated_gte=2026-10-12T15:50:22.095Z&sort=updated_at&order=asc&query=&org_id=&type=&fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();
```

--------------------------------

### Python: GET /unified/issue/{id}

Source: https://docs.unified.to/unified/issue/Retrieve_support_issue.md

Uses requests library to send a GET request to the Unified.to API. Requires an authorization header. The example retrieves the issue and stores the response.

```python
import requests

url = "https://api.unified.to/unified/issue/5de520f96e439b002043d8d8"

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.get(url, headers=headers)
```

--------------------------------

### Example: list jobs and submit a candidate (fetch)

Source: https://docs.unified.to/skills/unified-ats-jobboard/SKILL.md

JavaScript example using fetch to list open jobs, create a candidate, and create an application. Demonstrates the core request pattern with the Unified.to ATS API. Requires a connection ID and an API key stored in the UNIFIED_API_KEY environment variable.

```javascript
const BASE = 'https://api.unified.to';
const headers = {
    Authorization: `Bearer ${process.env.UNIFIED_API_KEY}`,
    'Content-Type': 'application/json',
};

// List open jobs for a job board
const jobsRes = await fetch(
    `${BASE}/ats/${connectionId}/job?limit=50&sort=created_at&order=desc`,
    { headers }
);
const jobs = await jobsRes.json();

// Create a candidate, then an application to a job
const candRes = await fetch(`${BASE}/ats/${connectionId}/candidate`, {
    method: 'POST',
    headers,
    body: JSON.stringify({
        name: 'Ada Lovelace',
        emails: [{ email: 'ada@example.com' }],
    }),
});
const candidate = await candRes.json();

await fetch(`${BASE}/ats/${connectionId}/application`, {
    method: 'POST',
    headers,
    body: JSON.stringify({
        candidate_id: candidate.id,
        job_id: 'JOB_ID',
    }),
});
```

--------------------------------

### Start the app with npm run start

Source: https://docs.unified.to/tutorials/build-a-simple-javascript-app.md

Run this command from the command line to start the app. The app will be available at localhost:1234.

```shell
npm run start

```

--------------------------------

### Java: GET shipping label with AsyncHttpClient

Source: https://docs.unified.to/shipping/label/Retrieve_a_label.md

Uses AsyncHttpClient to send a GET request to the shipping label endpoint. Requires an authorization header. The example prints the response to stdout.

```java
AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/shipping/5de520f96e439b002043d8dc/label/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();
```

--------------------------------

### Create Compute Instance with Go

Source: https://docs.unified.to/compute/instance/Create_an_instance.md

Go example using net/http to POST to the compute instance endpoint. Requires an authorization token and connection ID.

```go
import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/compute/5de520f96e439b002043d8dc/instance?fields=&raw=

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

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
```

--------------------------------

### Go: GET /scim/{connection_id}/groups

Source: https://docs.unified.to/scim/groups/List_groups.md

Uses net/http to send a GET request to the SCIM groups endpoint. Requires an authorization header. The example reads the response body.

```go
import (
	"fmt"
	"net/http"
	"io/ioutil"
)

url := `https://api.unified.to/scim/5de520f96e439b002043d8dc/groups?filter=&sortBy=&sortOrder=&startIndex=&count=

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

req.Header.Add("accept", "application/json")
req.Header.Add("authorization", ".....")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := ioutil.ReadAll(res.Body)
```

--------------------------------

### Java: GET /scim/{connection_id}/groups

Source: https://docs.unified.to/scim/groups/List_groups.md

Uses AsyncHttpClient to send a GET request to the SCIM groups endpoint. Requires an authorization header. The example prints the response to stdout.

```java
AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/scim/5de520f96e439b002043d8dc/groups?filter=&sortBy=&sortOrder=&startIndex=&count=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();
```

--------------------------------

### Install HubSpot CLI and create project

Source: https://docs.unified.to/skills/hubspot-oauth-app/SKILL.md

Install the HubSpot CLI (v7.6.0+ required for app projects), initialize or authenticate, and create a new project using the App template.

```bash
npm install -g @hubspot/cli@latest     # v7.6.0+ required for app projects
hs init                                # or: hs account auth   (CLI 7.4+, global config)
hs project create                      # choose the "App" template
```

--------------------------------

### Get observation using Ruby Net::HTTP

Source: https://docs.unified.to/healthcare/observation/Retrieve_an_observation.md

Ruby example using Net::HTTP to GET the observation endpoint. Enables SSL and sets accept and authorization headers.

```ruby
require 'uri'
require 'net/http'
require 'openssl'

url = URI("https://api.unified.to/healthcare/5de520f96e439b002043d8dc/observation/5de520f96e439b002043d8d8?fields=&raw=")

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

request = Net::HTTP::Get.new(url)
request["accept"] = 'application/json'
request["authorization"] = '....'

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

--------------------------------

### Clone repository and install dependencies

Source: https://docs.unified.to/tutorials/customize-auth-flow.md

Commands to clone the tutorial repository and install dependencies using npm.

```shell
git clone git@github.com:unified-to/unified-javascript-tutorial.git
cd unified-javascript-tutorial
npm i

```

--------------------------------

### Get observation using PHP cURL

Source: https://docs.unified.to/healthcare/observation/Retrieve_an_observation.md

PHP example using cURL to GET the observation endpoint. Sets return transfer, timeout, and custom request method with headers.

```php
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/healthcare/5de520f96e439b002043d8dc/observation/5de520f96e439b002043d8d8?fields=&raw=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);
```

--------------------------------

### Create Compute Instance with Python

Source: https://docs.unified.to/compute/instance/Create_an_instance.md

Python requests example to create a compute instance. Replace the connection ID and authorization token.

```python
import requests

url = "https://api.unified.to/compute/5de520f96e439b002043d8dc/instance?fields=&raw="

headers = {
    "accept": "application/json",
    "authorization": "....."
}

response = requests.post(url, headers=headers)
```

--------------------------------

### Get observation using Java AsyncHttpClient

Source: https://docs.unified.to/healthcare/observation/Retrieve_an_observation.md

Java example using AsyncHttpClient to GET the observation endpoint. Sends Accept and authorization headers, prints the response, and closes the client.

```java
AsyncHttpClient client = new DefaultAsyncHttpClient();

client.prepare("GET", "https://api.unified.to/healthcare/5de520f96e439b002043d8dc/observation/5de520f96e439b002043d8d8?fields=&raw=")
  .setHeader("accept", "application/json")
  .setHeader("authorization", ".....")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();
```

--------------------------------

### Example usage of product workflow

Source: https://docs.unified.to/guides/how_to_build_an_e_commerce_product_integration_with_unified.md

Demonstrates a complete workflow: creates a product with an AI-generated image and then lists all products, logging the results.

```typescript
async function main() {
	const name = "AI-Generated T-Shirt";

	const description = "A stylish t-shirt with a unique, AI-generated design.";

	const price = 29.99;

	// 1. Create the product with an AI-generated image
	const product = await createProduct(CONNECTION_SHOPIFY!, name, description, price);

	// 2. List products
	const products = await listProducts(CONNECTION_SHOPIFY!);

	console.log("Created product:", product);
	console.log("All products:", products);
}

main();
```
Tokens:
Raw