> This page is for Workforce.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.merge.dev/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.merge.dev/_mcp/server.

# Get connector

GET https://ah-api.merge.dev/api/v1/connectors/{slug}/

Retrieves a Connector by slug

Reference: https://docs.merge.dev/merge-workforce/agent-handler/connectors/connectors-retrieve

## Authentication

- `Authorization` header (bearer token, required) — Token-based authentication with required prefix "Bearer"

## Request

### Path parameters

- `slug` (string, required) — The slug of the Connector

### Query parameters

- `auth_mode` (string, optional) — Set to 'runtime' to return credential_fields instead of full auth_options.
- `include_tool_details` (boolean, optional) — When true, tools include input_schema, output_schema, and annotations.

## Response

### 200

- `id` (string, required) — Unique identifier for the Connector
- `name` (string, required) — Name of the Connector
- `slug` (string, required) — Slug identifier for the Connector
- `description` (string, required) — Description of what the Connector does
- `source_url` (string, required, nullable) — URL to the Connector's source website
- `logo_url` (string, required) — URL to the Connector's logo image
- `categories` (list of string, required, nullable) — Categories this connector belongs to
- `auth_options` (list of AuthOptionPublic, required) — Authentication options available for this connector
- `tools` (list of ConnectorTool, required) — List of available tools for this connector. By default each tool includes only name, description, and credit_type; pass include_tool_details=true on the detail endpoint to also include input_schema, output_schema, annotations, scopes, and endpoints.

## Types

### AuthOptionPublic

- `type` (string, required)
- `secrets` (list of SecretSchemaPublic, required)

### ConnectorTool

Full version of ConnectorTool serializer with schemas and annotations.

- `name` (string, required) — Name of the tool
- `description` (string, required, nullable) — Description of what the tool does
- `credit_type` (string, required) — Credit type consumed by the tool
- `input_schema` (map from string to any, optional) — JSON Schema describing the tool's input parameters. Only returned when include_tool_details=true.
- `output_schema` (map from string to any, optional, nullable) — JSON Schema describing the tool's output. Omitted when the tool does not declare one. Only returned when include_tool_details=true.
- `annotations` (map from string to boolean, optional, nullable) — MCP annotation hints (e.g. read_only, destructive). Only returned when include_tool_details=true.
- `scopes` (list of string, optional, default: []) — Third-party API scopes required by the tool. Only returned when include_tool_details=true.
- `endpoints` (list of string, optional, default: []) — Third-party API endpoints the tool calls. Only returned when include_tool_details=true.

### SecretSchemaPublic

- `name` (string, required)
- `human_readable_name` (string, required, nullable)
- `field_type` (string, required)
- `options` (list of SecretSchemaPublicOptionsItems, required, nullable)
- `prefix` (string, optional, nullable)
- `suffix` (string, optional, nullable)

### SecretSchemaPublicOptionsItems

- `label` (string, required)
- `value` (string, required)
- `default` (boolean, required)

## Examples

### Linear Connector Example

**Response**

```json
{
  "id": "134e0111-0f67-44f6-98f0-597000290bb3",
  "name": "Linear",
  "slug": "linear",
  "description": "A connector to the Linear project management platform",
  "source_url": "https://linear.app",
  "logo_url": "https://linear.app/favicon.ico",
  "categories": [
    "Project Management"
  ],
  "auth_options": [
    {
      "type": "Secrets",
      "secrets": [
        {
          "name": "api_key",
          "human_readable_name": "API key",
          "field_type": "TEXT",
          "options": [
            {
              "label": "string",
              "value": "string",
              "default": true
            }
          ]
        }
      ]
    },
    {
      "type": "OAuth2",
      "secrets": []
    }
  ],
  "tools": [
    {
      "name": "create_issue",
      "description": "Create a new issue in Linear",
      "credit_type": "string"
    },
    {
      "name": "list_issues",
      "description": "List issues in Linear",
      "credit_type": "string"
    }
  ],
  "source": "git"
}
```

**SDK Code**

```python Linear Connector Example
import requests

url = "https://ah-api.merge.dev/api/v1/connectors/linear/"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript Linear Connector Example
const url = 'https://ah-api.merge.dev/api/v1/connectors/linear/';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Linear Connector Example
package main

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

func main() {

	url := "https://ah-api.merge.dev/api/v1/connectors/linear/"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Linear Connector Example
require 'uri'
require 'net/http'

url = URI("https://ah-api.merge.dev/api/v1/connectors/linear/")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

```java Linear Connector Example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://ah-api.merge.dev/api/v1/connectors/linear/")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Linear Connector Example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://ah-api.merge.dev/api/v1/connectors/linear/', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Linear Connector Example
using RestSharp;

var client = new RestClient("https://ah-api.merge.dev/api/v1/connectors/linear/");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Linear Connector Example
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://ah-api.merge.dev/api/v1/connectors/linear/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Salesforce Connector Example

**Response**

```json
{
  "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "name": "Salesforce",
  "slug": "salesforce",
  "description": "Comprehensive Salesforce connector for managing CRM operations",
  "source_url": "https://salesforce.com",
  "logo_url": "https://salesforce.com/favicon.ico",
  "categories": [
    "CRM",
    "Sales",
    "Customer Service"
  ],
  "auth_options": [
    {
      "type": "Secrets",
      "secrets": [
        {
          "name": "instance_domain",
          "human_readable_name": "Instance domain",
          "field_type": "TEXT",
          "options": [
            {
              "label": "string",
              "value": "string",
              "default": true
            }
          ],
          "prefix": "https://",
          "suffix": "/"
        },
        {
          "name": "username",
          "human_readable_name": "Username",
          "field_type": "TEXT",
          "options": [
            {
              "label": "string",
              "value": "string",
              "default": true
            }
          ]
        },
        {
          "name": "password",
          "human_readable_name": "Password",
          "field_type": "TEXT",
          "options": [
            {
              "label": "string",
              "value": "string",
              "default": true
            }
          ]
        },
        {
          "name": "security_token",
          "human_readable_name": "Security token",
          "field_type": "TEXT",
          "options": [
            {
              "label": "string",
              "value": "string",
              "default": true
            }
          ]
        },
        {
          "name": "organization_id",
          "human_readable_name": "Organization ID",
          "field_type": "TEXT",
          "options": [
            {
              "label": "string",
              "value": "string",
              "default": true
            }
          ]
        }
      ]
    },
    {
      "type": "OAuth2",
      "secrets": [
        {
          "name": "instance_domain",
          "human_readable_name": "Instance domain",
          "field_type": "TEXT",
          "options": [
            {
              "label": "string",
              "value": "string",
              "default": true
            }
          ],
          "prefix": "https://",
          "suffix": "/"
        }
      ]
    }
  ],
  "tools": [
    {
      "name": "search_records",
      "description": "Search records in Salesforce",
      "credit_type": "string"
    }
  ],
  "source": "git"
}
```

**SDK Code**

```python Salesforce Connector Example
import requests

url = "https://ah-api.merge.dev/api/v1/connectors/linear/"

headers = {"Authorization": "Bearer <token>"}

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

print(response.json())
```

```javascript Salesforce Connector Example
const url = 'https://ah-api.merge.dev/api/v1/connectors/linear/';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Salesforce Connector Example
package main

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

func main() {

	url := "https://ah-api.merge.dev/api/v1/connectors/linear/"

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Salesforce Connector Example
require 'uri'
require 'net/http'

url = URI("https://ah-api.merge.dev/api/v1/connectors/linear/")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

```java Salesforce Connector Example
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://ah-api.merge.dev/api/v1/connectors/linear/")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```php Salesforce Connector Example
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://ah-api.merge.dev/api/v1/connectors/linear/', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

echo $response->getBody();
```

```csharp Salesforce Connector Example
using RestSharp;

var client = new RestClient("https://ah-api.merge.dev/api/v1/connectors/linear/");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift Salesforce Connector Example
import Foundation

let headers = ["Authorization": "Bearer <token>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://ah-api.merge.dev/api/v1/connectors/linear/")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```