> This page is for API Reference & Tools.

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

# Get HTTP connector

GET https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-connectors/{id}

Returns one HTTP connector by its `id`. Secrets come back redacted.

Reference: https://docs.moveworks.com/api-reference/configuration-api/tool-studio/http-connectors/get-http-connector

## Authentication

- `Authorization` header (bearer token, required) — JWT bearer token authentication. Include the Configuration API key in the Authorization header as 'Bearer \<token>'.

## Request

### Path parameters

- `id` (string, required) — The `id` of the HTTP connector, as returned when it was created or listed.

## Response

### 200

The HTTP connector

- `id` (string, optional) — Unique identifier of the HTTP connector, assigned by the server.
- `name` (string, optional) — Unique name of the connector, used by HTTP actions to refer to it. 2-64 letters, digits or underscores, starting with a letter. Cannot be changed, or reused after deletion.
- `display_name` (string, optional) — Label shown for the connector in Tool Studio. Read-only; defaults to the name.
- `description` (string, optional) — Description of the connector as shown in Tool Studio. Read-only.
- `base_url` (string, optional) — Base URL of the external API that every action path is appended to, for example https://api.example.com/v1. Must use https and a publicly reachable host unless the connector is routed through an on-premise agent.
- `basic_auth` (BasicAuthSettings, optional) — HTTP basic authentication with a username and password.
- `api_key_auth` (ApiKeyAuthSettings, optional) — API key authentication, sent in a header or query parameter.
- `oauth2` (OAuth2Settings, optional) — OAuth 2.0 authentication.
- `jwt_auth` (JwtAuthSettings, optional) — JWT bearer authentication signed with a private key you provide.
- `jwks_auth` (JwksAuthSettings, optional) — JWT bearer authentication signed with a key pair that Moveworks generates and rotates.
- `no_auth` (NoAuthSettings, optional) — No authentication. Set to an empty object to send requests without credentials.
- `headers` (list of RequestParameterSettings, optional) — Headers added to every request made through this connector.
- `query_params` (list of RequestParameterSettings, optional) — Query parameters added to every request made through this connector.
- `x509_options` (X509OptionsSettings, optional) — Client certificate and private key for mutual TLS. Used only when both are set.
- `csrf_token_options` (CsrfTokenOptionsSettings, optional) — Settings for fetching a CSRF token before requests, for systems that require one.
- `updated_time` (datetime, optional) — When the configuration was last updated.
- `updated_by` (string, optional) — Who last updated the configuration.
- `version` (Version, optional) — Document version. On update, send back the num from your last read.

## Errors

### 401 Unauthorized Error

Unauthorized - the `Authorization` header is missing or the token is invalid

- `error` (ErrorResponseError, required)

### 403 Forbidden Error

Forbidden - the API key isn't allowed to change this configuration, or the configuration is frozen for your organization

- `error` (ErrorResponseError, required)

### 404 Not Found Error

Not found - no item with this `id` exists in your organization

- `error` (ErrorResponseError, required)

### 429 Too Many Requests Error

Too many requests - the organization exceeded the Configuration API rate limit. Back off and retry.

- `error` (ErrorResponseError, required)

### 500 Internal Server Error

Internal server error - retry the request

- `error` (ErrorResponseError, required)

## Types

### BasicAuthSettings

- `username` (string, optional) — Username for HTTP basic authentication.
- `password` (string, optional) — Password for HTTP basic authentication. Secret: always returned masked as *****.

### ApiKeyAuthSettings

- `api_key` (string, optional) — API key issued by the external system. Secret: always returned masked as *****.
- `query_param` (ApiKeyQueryParamSettings, optional) — Send the key as a query parameter.
- `header` (AuthHeaderSettings, optional) — Send the key in a request header. Defaults to the Authorization header with the value Bearer followed by the key.

### OAuth2Settings

- `token_url` (string, optional) — Token endpoint URL of the authorization server. Optional for grants that do not exchange a token.
- `client_credentials_grant` (OAuth2ClientCredentialsGrantSettings, optional) — OAuth 2.0 client credentials grant.
- `password_grant` (OAuth2PasswordGrantSettings, optional) — OAuth 2.0 resource owner password grant.
- `refresh_token_grant` (OAuth2RefreshTokenGrantSettings, optional) — OAuth 2.0 refresh token grant, using a refresh token you provide.
- `jwt_grant` (JwtAuthSettings, optional) — JWT bearer assertion grant, signed with a private key you provide.
- `authorization_code_grant` (OAuth2AuthorizationCodeGrantSettings, optional) — OAuth 2.0 authorization code grant, where each user signs in to the external system and grants access.
- `saml_bearer_grant` (OAuth2SamlBearerGrantSettings, optional) — SAML 2.0 bearer assertion grant, using an assertion that Moveworks issues and signs.
- `jwks_grant` (JwksAuthSettings, optional) — JWT bearer assertion grant, signed with a key pair that Moveworks generates and rotates.
- `response_options` (OAuth2ResponseOptionsSettings, optional) — How to read the token response when it is not the standard JSON object with access_token and expires_in.
- `auth_header` (AuthHeaderSettings, optional) — How the access token is added to requests. Defaults to the Authorization header with the token as its value.
- `request_options` (OAuth2RequestOptionsSettings, optional) — Extra data to send on the token request beyond the standard grant fields.

### JwtAuthSettings

- `private_key` (string, optional) — PEM private key used to sign the JWT. Secret: always returned masked as *****.
- `key_id` (string, optional) — Key ID (kid header) that identifies the private key. Secret: always returned masked as *****.
- `algorithm` (enum, optional) — Signing algorithm. One of: ES256, RS256, HS256.
  - Allowed values: `ES256`, `RS256`, `HS256`
- `claims` (JwtClaimsSettings, optional) — Registered claims of the issued JWT.
- `headers` (list of JwtHeaderSettings, optional) — Additional JWT header parameters.
- `additional_claims` (list of JwtHeaderSettings, optional) — Claims to include beyond the registered claims.
- `assertion_key` (string, optional) — Name of the request field the signed JWT is sent under. Defaults to assertion.

### JwksAuthSettings

- `jwks` (string, optional) — Moveworks-generated key pair this connector signs with. Leave empty to generate a new key pair; send back the value from your last read to keep the current key. ID of an existing JwksSecret; not available through the Configuration API.
- `rotation_grace_period_hours` (JwksAuthSettingsRotationGracePeriodHours, optional) — Hours the previous key stays valid after a rotation. 0 uses the default.
- `rotation_interval_days` (JwksAuthSettingsRotationIntervalDays, optional) — Days between key rotations. 0 uses the default of 30 days.
- `claims` (JwtClaimsSettings, optional) — Registered claims of the issued JWT.
- `headers` (list of JwtHeaderSettings, optional) — Additional JWT header parameters.
- `additional_claims` (list of JwtHeaderSettings, optional) — Claims to include beyond the registered claims.
- `assertion_key` (string, optional) — Name of the request field the signed JWT is sent under. Defaults to assertion.

### NoAuthSettings

### RequestParameterSettings

- `key` (string, optional) — Header or query parameter name.
- `value` (string, optional) — Literal value.
- `credential` (TemplatedSecretSettings, optional) — Value built by inserting a secret into a pattern.

### X509OptionsSettings

- `certificate` (string, optional) — PEM client certificate. Secret: always returned masked as *****.
- `private_key` (string, optional) — PEM private key for the client certificate. Secret: always returned masked as *****.

### CsrfTokenOptionsSettings

- `endpoint_url` (string, optional) — Endpoint that issues the CSRF token, typically the service root. It is called with GET and the header x-csrf-token: Fetch, and the returned token is sent on later requests.

### Version

- `num` (integer, optional) — Version number set by the server. On update, send the num from your last read; a stale num is rejected as a conflict.
- `change_description` (string, optional) — A short note describing this change. Required on every create and update.

### ErrorResponseError

- `code` (string, optional) — A machine-readable error code.
- `message` (string, optional) — What went wrong, and for a rejected field, which rule it broke.

### ApiKeyQueryParamSettings

- `name` (string, optional) — Name of the query parameter that carries the API key.

### AuthHeaderSettings

- `key` (string, optional) — Name of the header that carries the credential. Defaults to Authorization.
- `value_pattern` (string, optional) — Header value template, with %s replaced by the credential, for example Bearer %s. Defaults to %s for OAuth 2.0 tokens and Bearer %s for API keys.

### OAuth2ClientCredentialsGrantSettings

- `client_id` (string, optional) — Client ID issued by the authorization server.
- `client_secret` (string, optional) — Client secret issued by the authorization server. Secret: always returned masked as *****.
- `scope` (string, optional) — Scope to request from the authorization server.

### OAuth2PasswordGrantSettings

- `client_id` (string, optional) — Client ID issued by the authorization server.
- `client_secret` (string, optional) — Client secret issued by the authorization server. Secret: always returned masked as *****.
- `username` (string, optional) — Username of the account the token is requested for.
- `password` (string, optional) — Password of the account the token is requested for. Secret: always returned masked as *****.

### OAuth2RefreshTokenGrantSettings

- `client_id` (string, optional) — Client ID issued by the authorization server.
- `client_secret` (string, optional) — Client secret issued by the authorization server. Secret: always returned masked as *****.
- `refresh_token` (string, optional) — Refresh token used to obtain access tokens. Secret: always returned masked as *****.
- `scope` (string, optional) — Scope to request from the authorization server.

### OAuth2AuthorizationCodeGrantSettings

- `authorization_url` (string, optional) — Authorization endpoint URL of the authorization server, where users sign in and grant access.
- `client_id` (string, optional) — Client ID issued by the authorization server.
- `client_secret` (string, optional) — Client secret issued by the authorization server. Secret: always returned masked as *****.
- `scope` (string, optional) — Scope to request from the authorization server.
- `authorization_query_params` (list of AuthorizationQueryParamSettings, optional) — Additional query parameters added to the authorization request.
- `revoke_access_token_options` (OAuth2RevokeAccessTokenOptionsSettings, optional) — How to revoke a user's access token when they disconnect.
- `refresh_access_token_options` (OAuth2RefreshAccessTokenOptionsSettings, optional) — Options for refreshing access tokens.
- `pkce_algorithm` (string, optional) — PKCE code challenge method. One of: SHA256, PLAIN. Leave unset to disable PKCE. SHA256 is recommended; use PLAIN only if the server does not support S256.
- `on_premise_service_name` (string, optional) — Service name configured in the Moveworks on-premise agent, for connectors routed through that agent. Setting it also skips the public-host check on base_url.

### OAuth2SamlBearerGrantSettings

- `issuer` (string, optional) — SAML entity ID that Moveworks issues assertions as. Required for this grant.
- `client_id` (string, optional) — Client ID issued by the authorization server.
- `target_audience` (string, optional) — Entity ID of the target system, placed in the assertion's audience.
- `target_recipient` (string, optional) — URL that receives the assertion, typically the token endpoint.
- `signing_private_key` (string, optional) — PEM private key used to sign the assertions. Secret: always returned masked as *****.
- `signing_certificate` (string, optional) — X.509 certificate matching the signing private key. Secret: always returned masked as *****.
- `assertion_ttl_seconds` (long, optional) — How long, in seconds, an issued assertion is valid. Defaults to 300.
- `online_flow` (SamlOnlineFlowSettings, optional) — Build the assertion from the user's assertion issued and signed by your identity provider.
- `offline_flow` (SamlOfflineFlowSettings, optional) — Build the assertion from static attributes and the requesting user's record, without contacting an identity provider.

### OAuth2ResponseOptionsSettings

- `text` (boolean, optional) — If true, the token is the entire response body rather than a JSON object.
- `json` (OAuth2JsonResponseSettings, optional) — Keys to read when the token response is a JSON object with non-standard keys.

### OAuth2RequestOptionsSettings

- `custom_grant_type` (string, optional) — Value to send as grant_type instead of the selected grant's standard value.
- `additional_headers` (list of OAuth2HeaderSettings, optional) — Additional headers sent on the token request.
- `additional_request_data` (list of OAuth2RequestDataSettings, optional) — Additional body fields sent on the token request.

### JwtClaimsSettings

- `expiry_seconds` (integer, optional) — Token lifetime in seconds from issue, used for the exp claim. Must be 0 or greater.
- `issuer` (string, optional) — Issuer of the token (iss claim).
- `audience` (string, optional) — Audience of the token (aud claim).
- `subject` (string, optional) — Subject of the token (sub claim).
- `jti_enabled` (boolean, optional) — If true, each token includes a unique jti claim.

### JwtHeaderSettings

- `key` (string, optional) — Header parameter or claim name.
- `value` (string, optional) — Header parameter or claim value. Secret: always returned masked as *****.
- `item_ref` (string, optional) — Row identifier assigned by the server. Leave unset on create; on update, send back the value from your last read so the row is matched correctly.

### JwksAuthSettingsRotationGracePeriodHours

Hours the previous key stays valid after a rotation. 0 uses the default.

- integer
- string

### JwksAuthSettingsRotationIntervalDays

Days between key rotations. 0 uses the default of 30 days.

- integer
- string

### TemplatedSecretSettings

- `pattern` (string, optional) — Value template, with %s replaced by the secret, for example Bearer %s.
- `secret` (string, optional) — Secret inserted into the pattern. Secret: always returned masked as *****.

### AuthorizationQueryParamSettings

- `key` (string, optional) — Query parameter name.
- `value` (string, optional) — Query parameter value.
- `item_ref` (string, optional) — Row identifier assigned by the server. Leave unset on create; on update, send back the value from your last read so the row is matched correctly.

### OAuth2RevokeAccessTokenOptionsSettings

- `revoke_url` (string, optional) — Token revocation endpoint URL.
- `revoke_instructions_url` (string, optional) — URL of instructions shown to the user when revocation fails.
- `revoke_access_token_authentication` (string, optional) — How the access token is passed to the revocation endpoint. One of: BODY, URL_PARAMETERS, TOKEN_AUTH, BASIC_AUTH.
- `revocation_token_key` (string, optional) — Name of the request body field that carries the token. Defaults to token.
- `revocation_headers` (list of OAuth2HeaderSettings, optional) — Additional headers sent on the revocation request.
- `revocation_method` (string, optional) — HTTP method of the revocation request. One of: GET, POST, PUT, DELETE, PATCH.

### OAuth2RefreshAccessTokenOptionsSettings

- `scope_disabled` (boolean, optional) — If true, the scope parameter is omitted from refresh token requests.

### SamlOnlineFlowSettings

- `saml_idp_url` (string, optional) — Identity provider endpoint that issues the user's assertion.
- `idp_signing_certificate` (string, optional) — X.509 signing certificate of the identity provider, used to verify its assertions. Secret: always returned masked as *****.
- `expected_audience` (string, optional) — Audience the identity provider's assertion must carry (the Moveworks entity ID).
- `attribute_mappings` (list of SamlAttributeMappingSettings, optional) — Mappings from identity provider attributes to target system attributes.

### SamlOfflineFlowSettings

- `static_attributes` (list of SamlStaticAttributeSettings, optional) — Attributes included unchanged in every assertion.

### OAuth2JsonResponseSettings

- `expires_in_key` (string, optional) — Response key that holds the token expiry. Defaults to expires_in.
- `access_token_key` (string, optional) — Response key that holds the access token. Defaults to access_token.
- `expires_in_format` (string, optional) — How the expiry value is encoded. One of: SECONDS, DATE. Defaults to SECONDS.

### OAuth2HeaderSettings

- `key` (string, optional) — Header name.
- `value` (string, optional) — Header value.
- `item_ref` (string, optional) — Row identifier assigned by the server. Leave unset on create; on update, send back the value from your last read so the row is matched correctly.

### OAuth2RequestDataSettings

- `key` (string, optional) — Body field name.
- `value` (string, optional) — Body field value.
- `item_ref` (string, optional) — Row identifier assigned by the server. Leave unset on create; on update, send back the value from your last read so the row is matched correctly.

### SamlAttributeMappingSettings

- `key` (string, optional) — Attribute name in the target system.
- `value` (string, optional) — Attribute name in the identity provider's assertion.
- `item_ref` (string, optional) — Row identifier assigned by the server. Leave unset on create; on update, send back the value from your last read so the row is matched correctly.

### SamlStaticAttributeSettings

- `key` (string, optional) — Attribute name.
- `value` (string, optional) — Attribute value.
- `item_ref` (string, optional) — Row identifier assigned by the server. Leave unset on create; on update, send back the value from your last read so the row is matched correctly.

## Examples

**Response**

```json
{
  "id": "3f6c1e2a-8b4d-4c7e-9a1f-2d5b6c7e8f90",
  "name": "erp_production",
  "base_url": "https://erp.example.com",
  "api_key_auth": {
    "api_key": "••••••••",
    "header": {
      "key": "X-API-Key",
      "value_pattern": "%s"
    }
  },
  "headers": [
    {
      "key": "Accept",
      "value": "application/json"
    }
  ],
  "updated_time": "2026-11-12T18:04:11Z",
  "updated_by": "admin@example.com",
  "version": {
    "num": 2,
    "change_description": "Initial version."
  }
}
```

**SDK Code**

```python HTTP Connectors endpoints_getHTTPConnector_example
import requests

url = "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-connectors/id"

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

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

print(response.json())
```

```javascript HTTP Connectors endpoints_getHTTPConnector_example
const url = 'https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-connectors/id';
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 HTTP Connectors endpoints_getHTTPConnector_example
package main

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

func main() {

	url := "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-connectors/id"

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

url = URI("https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-connectors/id")

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

HttpResponse<String> response = Unirest.get("https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-connectors/id")
  .header("Authorization", "Bearer <token>")
  .asString();
```

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

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-connectors/id', [
  'headers' => [
    'Authorization' => 'Bearer <token>',
  ],
]);

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

```csharp HTTP Connectors endpoints_getHTTPConnector_example
using RestSharp;

var client = new RestClient("https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-connectors/id");
var request = new RestRequest(Method.GET);
request.AddHeader("Authorization", "Bearer <token>");
IRestResponse response = client.Execute(request);
```

```swift HTTP Connectors endpoints_getHTTPConnector_example
import Foundation

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

let request = NSMutableURLRequest(url: NSURL(string: "https://api.moveworks.ai/configurations/v1alpha1/platform/extensions/http-connectors/id")! 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()
```