Skip to main content
GET
/
v1
/
connectors
/
search
Search Connectors
curl --request GET \
  --url https://api.example.com/v1/connectors/search \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "description": "<string>",
    "logo": "<string>",
    "status": "<string>",
    "version": "<string>",
    "open_api_spec_id": "<string>",
    "organization_id": "<string>",
    "total_operations": 123,
    "readiness_score": 123,
    "using_built_in_auth": false,
    "connection_hint": "<string>",
    "server_url": {},
    "connections": []
  }
]
Search for connectors by name or description using fuzzy matching. Returns matching connectors with their connections.

​
Query Parameters

​
query
string
required
Search query to match against connector name and description

​
Response

Returns an array of ConnectorItem objects matching the search query. Each item includes the connector’s connections.

​
Example Request

curl -X GET -H "x-api-key: <your-api-key>" \
  "https://api.xpander.ai/v1/connectors/search?query=slack"

​
Notes

  • Uses fuzzy matching against connector name and description
  • Personal connections are filtered based on the API key owner

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Query Parameters

​
query
string
required

Search query to match against connector name and description

Response

Successful Response

​
id
string
required

Unique identifier of the connector.

​
name
string
required

Display name of the connector (e.g., 'Slack', 'Jira', 'GitHub').

​
description
string | null

Description of what this connector integrates with and its capabilities.

​
logo
string | null

Logo identifier for the connector's icon. Resolve via the platform's CDN.

​
status
string | null

Current status of the connector. 'ready' means it's available for use. Other values indicate processing or issues.

​
version
string | null

Latest available version of the connector's OpenAPI specification.

​
open_api_spec_id
string | null

ID of the connector's OpenAPI specification in the catalog service. Used internally to resolve available operations.

​
organization_id
string | null

If set, this is a custom connector owned by this organization. If null, it's a public catalog connector available to all organizations.

​
total_operations
integer | null

Total number of API operations (endpoints) available in this connector.

​
readiness_score
number | null

Quality score (0-1) indicating how well-documented and tested the connector's operations are.

​
using_built_in_auth
boolean | null
default:false

Whether this connector uses xpander.ai's built-in authentication flow (managed OAuth2, etc.) rather than requiring manual credential setup.

​
connection_hint
string | null

Human-readable hint or instructions for setting up a connection to this connector.

​
server_url
Server Url · object

Target server URLs for this connector's API. Maps environment identifiers to base URLs.

​
connections
ConnectionSummary · object[] | null

List of active connections (org↔connector bindings) for this connector within your organization. Only includes connections visible to the requesting user based on access scope.