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.
Authentication
AuthorizationBearerSend your token in the Authorization: Bearer <token> header. See Authentication for API keys and OAuth.
Query parameters
includeAddedbooleanOptionalfalseWhether to include providers already added to the workspace for metadata lookup.
Responses
200 OK
application/json
presetsarray of object or nullOptionalThe predefined connector presets.
Show 12 properties
hasConfigurationbooleanOptionalWhether setup accepts endpoint values or custom OAuth client settings.
keystring or nullOptionalThe stable connector preset key.
namestring or nullOptionalThe connector preset display name.
logoPathstring or nullOptionalThe connector preset logo path.
supportsDynamicClientRegistrationbooleanOptionalWhether the connector supports dynamic client registration.
requiresOAuthClientSecretbooleanOptionalWhether static OAuth configuration requires a client secret.
documentationUrlstring or nullOptionalThe connector documentation URL.
isDisabledbooleanOptionalWhether the connector preset is disabled.
managedOAuthProviderKeystring or nullOptionalThe key of the managed OAuth provider.
showOAuthCredentialsboolean or nullOptionalWhether OAuth credential inputs should be displayed.
companySearchobjectOptionalShow 3 properties
enabledbooleanOptionalWhether the connector preset supports company search.
toolNamestring or nullOptionalThe connector tool used for company search.
queryParameterNamestring or nullOptionalThe tool parameter that receives the search query.
endpointFieldsarray of object or nullOptionalThe user-facing fields used to configure the connector endpoint.
Show 9 properties
keystring or nullOptionalThe stable field key submitted when creating the connector.
controlTypestring or nullOptionalThe control type used to render the field.
labelKeystring or nullOptionalThe frontend translation key used to label the field.
placeholderKeystring or nullOptionalThe optional frontend translation key used for the field placeholder.
validationKindstring or nullOptionalThe optional validation kind applied to text values.
isRequiredbooleanOptionalWhether the field must have a value.
defaultValuestring or nullOptionalThe optional default field value.
maxLengthinteger or nullOptionalThe optional maximum text length.
optionsarray of object or nullOptionalThe available options for select fields.
Show 2 properties
valuestring or nullOptionalThe stable option value submitted when creating the connector.
labelKeystring or nullOptionalThe frontend translation key used to label the option.
oauthCallbackUristring or nullOptionalThe OAuth callback URI to register with OAuth providers.
401 Unauthorized
application/json
codestringRequired1 The error code.
descriptionstringRequired1 The description of the error.
linkstringRequired1 The link to the API documentation page.
detailsarray of string or nullOptionalA list of details describing the error.
validationErrorsarray of object or nullOptionalIf a validation error occurred, this contains the validation errors for each property.
Show 2 properties
propertystring or nullOptionalThe name of the property that failed validation.
messagestring or nullOptionalThe reason why this property failed validation.
traceIdstring or nullOptionalThe request trace id for tracking the request.