---
title: "Create connection"
url: "https://docs.unified.to/unified/connection/Create_connection"
description: "API reference for Create connection. Launch multiple pre-built Connection integrations today with zero maintenance — all through a single API."
generated_at: "2026-06-10T19:27:08.164Z"
---
# Create connection

 POST/unified/connection

Used only to import existing customer credentials; use "Authorize new connection" instead

## Payload

A connection represents a specific authentication of an integration.

**id**string  read-only 

Unique identifier for this integration object

**created\_at**date  read-only 

The date that this integration object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**updated\_at**date  read-only 

The last date that this integration object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**workspace\_id**string  read-only 

(reference to KmsSpace)

**integration\_type**string  required 

The integration type

**integration\_name**string 

**external\_xref**string 

customer's user ID

**permissions** enum array  required 

Valid values:

 "accounting\_account\_read" 

 "accounting\_account\_write" 

 "accounting\_transaction\_read" 

 "accounting\_transaction\_write" 

 "accounting\_journal\_read" 

**categories** enum array  required 

Valid values:

 "passthrough" 

 "hris" 

 "ats" 

 "auth" 

 "crm" 

The Integration categories that this connection supports

**auth**object 

An authentication object that represents a specific authorized user's connection to an integration.

**is\_paused**boolean  read-only 

Whether this integration has exceed the monthly limit of the plan

**auth\_aws\_arn**string 

the AWS ARN / secretID for the stored auth field

**environment**string 

**auth\_azure\_keyvault\_id**string 

the Azure Key Vault ID for the stored auth field

**auth\_gcp\_secret\_name**string 

the Google Cloud Secret Manager name for the stored auth field

**auth\_hashi\_vault\_path**string 

the HashiCorp Vault path for the stored auth field

**last\_healthy\_at**date  read-only 

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**last\_unhealthy\_at**date  read-only 

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**secretsmanager\_id**string 

the ID of the SecretsManager object

**secretsmanager\_key**string 

the key/path/name of the secret within the vault

## Returns

[Connection](/unified/connection/model)

A connection represents a specific authentication of an integration.

**id**string  read-only 

Unique identifier for this integration object

**created\_at**date  read-only 

The date that this integration object was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**updated\_at**date  read-only 

The last date that this integration object was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**workspace\_id**string  read-only 

(reference to KmsSpace)

**integration\_type**string  required 

The integration type

**integration\_name**string 

**external\_xref**string 

customer's user ID

**permissions** enum array  required 

Valid values:

 "accounting\_account\_read" 

 "accounting\_account\_write" 

 "accounting\_transaction\_read" 

 "accounting\_transaction\_write" 

 "accounting\_journal\_read" 

**categories** enum array  required 

Valid values:

 "passthrough" 

 "hris" 

 "ats" 

 "auth" 

 "crm" 

The Integration categories that this connection supports

**auth**object 

An authentication object that represents a specific authorized user's connection to an integration.

**is\_paused**boolean  read-only 

Whether this integration has exceed the monthly limit of the plan

**auth\_aws\_arn**string 

the AWS ARN / secretID for the stored auth field

**environment**string 

**auth\_azure\_keyvault\_id**string 

the Azure Key Vault ID for the stored auth field

**auth\_gcp\_secret\_name**string 

the Google Cloud Secret Manager name for the stored auth field

**auth\_hashi\_vault\_path**string 

the HashiCorp Vault path for the stored auth field

**last\_healthy\_at**date  read-only 

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**last\_unhealthy\_at**date  read-only 

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

**secretsmanager\_id**string 

the ID of the SecretsManager object

**secretsmanager\_key**string 

the key/path/name of the secret within the vault

## Code Samples

### Node.js SDK

```
import { UnifiedTo } from '@unified-api/typescript-sdk';

const sdk = new UnifiedTo({
    security: {
        jwt: '<YOUR_API_KEY_HERE>',
    },
});

const results = await sdk.unified.createUnifiedConnection({ 

 });
```

### Node.js (axios)

```
const options = {
  method: 'POST',
  url: 'https://api.unified.to/unified/connection',
  headers: {
    authorization: 'bearer .....'
  },
  data: undefined,

};

const results = await axios.request(options);
```

### Java

```
AsyncHttpClient client = new DefaultAsyncHttpClient();

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

client.close();
```

### Go

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

url := `https://api.unified.to/unified/connection

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)
```

### Python

```
import requests

url = "https://api.unified.to/unified/connection"

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

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

### PHP

```
$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.unified.to/unified/connection",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "accept: application/json",
    "authorization: ....."
  ],
]);
```

### Ruby

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

url = URI("https://api.unified.to/unified/connection")

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

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

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

### cURL

```
curl --request POST \
  --url 'https://api.unified.to/unified/connection' \
  --header 'accept: application/json' \
  --header 'authorization: .....'
```