> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://developers.awork.com/apiv1/agent-runtime/get-connectors-presets/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developers.awork.com/_mcp/server.

# Lists the predefined connector presets available to the workspace.

GET https://api.awork.com/api/v1/agents/connectors/presets

Lists predefined connector presets and the OAuth callback URI used for connector setup.
Create connectors in the awork app.
The response describes setup options; it does not create a connector.Any authenticated user.

Reference: https://developers.awork.com/apiv1/agent-runtime/get-connectors-presets

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `includeAdded` (boolean, optional, default: false) — Whether to include providers already added to the workspace for metadata lookup.

## Response

### 200

OK

- `presets` (list of ConnectorPresetResponseModel, optional, nullable) — The predefined connector presets.
- `oauthCallbackUri` (string, optional, nullable) — The OAuth callback URI to register with OAuth providers.

## Errors

### 401 Unauthorized Error

Unauthorized

- `code` (string, required) — The error code.
- `description` (string, required) — The description of the error.
- `link` (string, required) — The link to the API documentation page.
- `details` (list of string, optional, nullable) — A list of details describing the error.
- `validationErrors` (list of ValidationErrorResponse, optional, nullable) — If a validation error occurred, this contains the validation errors for each property.
- `traceId` (string, optional, nullable) — The request trace id for tracking the request.

## Types

### ConnectorPresetResponseModel

- `hasConfiguration` (boolean, optional) — Whether setup accepts endpoint values or custom OAuth client settings.
- `key` (string, optional, nullable) — The stable connector preset key.
- `name` (string, optional, nullable) — The connector preset display name.
- `logoPath` (string, optional, nullable) — The connector preset logo path.
- `supportsDynamicClientRegistration` (boolean, optional) — Whether the connector supports dynamic client registration.
- `requiresOAuthClientSecret` (boolean, optional) — Whether static OAuth configuration requires a client secret.
- `documentationUrl` (string, optional, nullable) — The connector documentation URL.
- `isDisabled` (boolean, optional) — Whether the connector preset is disabled.
- `managedOAuthProviderKey` (string, optional, nullable) — The key of the managed OAuth provider.
- `showOAuthCredentials` (boolean, optional, nullable) — Whether OAuth credential inputs should be displayed.
- `companySearch` (ConnectorPresetCompanySearchModel, optional)
- `endpointFields` (list of ConnectorEndpointFieldResponseModel, optional, nullable) — The user-facing fields used to configure the connector endpoint.

### ValidationErrorResponse

The validation error response.

- `property` (string, optional, nullable) — The name of the property that failed validation.
- `message` (string, optional, nullable) — The reason why this property failed validation.

### ConnectorPresetCompanySearchModel

- `enabled` (boolean, optional) — Whether the connector preset supports company search.
- `toolName` (string, optional, nullable) — The connector tool used for company search.
- `queryParameterName` (string, optional, nullable) — The tool parameter that receives the search query.

### ConnectorEndpointFieldResponseModel

Describes one user-facing field used to configure a predefined connector endpoint.

- `key` (string, optional, nullable) — The stable field key submitted when creating the connector.
- `controlType` (string, optional, nullable) — The control type used to render the field.
- `labelKey` (string, optional, nullable) — The frontend translation key used to label the field.
- `placeholderKey` (string, optional, nullable) — The optional frontend translation key used for the field placeholder.
- `validationKind` (string, optional, nullable) — The optional validation kind applied to text values.
- `isRequired` (boolean, optional) — Whether the field must have a value.
- `defaultValue` (string, optional, nullable) — The optional default field value.
- `maxLength` (integer, optional, nullable) — The optional maximum text length.
- `options` (list of ConnectorEndpointOptionResponseModel, optional, nullable) — The available options for select fields.

### ConnectorEndpointOptionResponseModel

Represents one selectable connector endpoint option.

- `value` (string, optional, nullable) — The stable option value submitted when creating the connector.
- `labelKey` (string, optional, nullable) — The frontend translation key used to label the option.

## Examples

**Response**

```json
{
  "presets": [
    {
      "hasConfiguration": false,
      "key": "hubspot",
      "name": "HubSpot",
      "logoPath": "images/integrations/hubspot_icon.svg",
      "supportsDynamicClientRegistration": false,
      "requiresOAuthClientSecret": false,
      "documentationUrl": "https://developers.hubspot.com/docs/apps/developer-platform/build-apps/integrate-with-the-remote-hubspot-mcp-server",
      "isDisabled": false,
      "managedOAuthProviderKey": "hubspot",
      "showOAuthCredentials": false,
      "companySearch": {
        "enabled": true,
        "toolName": "search_companies",
        "queryParameterName": "query"
      },
      "endpointFields": [
        {
          "key": "subdomain",
          "controlType": "text",
          "labelKey": "subdomain",
          "placeholderKey": "subdomain",
          "validationKind": "hostLabel",
          "isRequired": true,
          "defaultValue": "northstar-agency",
          "maxLength": 63,
          "options": [
            {
              "value": "eu",
              "labelKey": "eu"
            }
          ]
        }
      ]
    }
  ],
  "oauthCallbackUri": "https://app.awork.com/api/v1/agents/connectors/auth/callback"
}
```

**SDK Code**

```python
import requests

url = "https://api.awork.com/api/v1/agents/connectors/presets"

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

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

print(response.json())
```

```javascript
const url = 'https://api.awork.com/api/v1/agents/connectors/presets';
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
package main

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

func main() {

	url := "https://api.awork.com/api/v1/agents/connectors/presets"

	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
require 'uri'
require 'net/http'

url = URI("https://api.awork.com/api/v1/agents/connectors/presets")

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
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.awork.com/api/v1/agents/connectors/presets")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.awork.com/api/v1/agents/connectors/presets', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp
using RestSharp;

var client = new RestClient("https://api.awork.com/api/v1/agents/connectors/presets");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.awork.com/api/v1/agents/connectors/presets")! 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()
```