---
title: "Get connector details"
method: GET
path: "/_api/connectors/{connector-name}"
tags: ["Connections"]
---

# Get connector details

`GET /_api/connectors/{connector-name}`

## Request

- The document declares no server URL.
- Auth: one of:
  - API key in header `Authorization`
  - HTTP bearer
- TypeScript: <https://skmtc.dev/macrometa/apis/macrometa-api-reference/docs/_api/connectors/:connector-name/get.ts> (a function with typed inputs; its response is checked against the schema)

Obtain comprehensive information about the connector,
including the configuration details necessary for setting up an connection using this connector.

## Path parameters

- `connector-name` string, required

## Query parameters

- `type` 'source' | 'target'

## Response `200`

Succesfully fetched the connector.

- ConnectorEntityResponse
  - `error` boolean, required
  - `code` integer
  - `result` ConnectorEntity[]
    - `name` string: Name of the connector. This is used as the ID of the connector.
    - `displayName` string: Name that can be used by GUI clients to display the connector.
    - `description` string
    - `type` string: Specifies whether the connector serves as a source or a target.
    - `version` string: Version of the connector.

## Other responses

- `401`: Failed to authenticate the request.
- `404`: Failed to find the connector.

---

[API](https://skmtc.dev/macrometa/apis/macrometa-api-reference.md) - [All operations](https://skmtc.dev/macrometa/apis/macrometa-api-reference/llms.txt) - [OpenAPI document](https://skmtc.dev/macrometa/apis/macrometa-api-reference/revisions/2006b6d7f31d?raw)