/v1/connectorsList ConnectorsReturns a list of connectors ordered by descending creation date (newer first). See 'Managing your Connector' for more information.
Parameters
limitnumberqueryMaximum number of connectors to return [0, 100].
offsetnumberqueryNumber of connectors to skip before returning results [0, inf].
X-Client-NamestringheaderThe name of the project that is making the request.
Responses
connectorsarray of objectrequiredShow child attributes
Show array items
A connector allows you to integrate data sources with the '/chat' endpoint to create grounded generations with citations to the data source. documents to help answer users.
activebooleanWhether the connector is active or not.
auth_statusstringThe OAuth status for the user making the request. One of ["valid", "expired", ""]. Empty string (field is omitted) means the user has not authorized the connector yet.
auth_typestring · enumThe type of authentication/authorization used by the connector. Possible values: [oauth, service_auth]
continue_on_failurebooleanWhether a chat request should continue or not if the request to this connector fails.
created_atstring · date-timerequiredThe UTC time at which the connector was created.
descriptionstringA description of the connector.
excludesarray of stringA list of fields to exclude from the prompt (fields remain in the document).
Show child attributes
idstringrequiredThe unique identifier of the connector (used in both `/connectors` & `/chat` endpoints). This is automatically created from the name of the connector upon registration.
namestringrequiredA human-readable name for the connector.
oauthobjectShow child attributes
authorize_urlstringrequiredThe OAuth 2.0 /authorize endpoint to use when users authorize the connector.
client_idstringThe OAuth 2.0 client ID. This field is encrypted at rest.
client_secretstringThe OAuth 2.0 client Secret. This field is encrypted at rest and never returned in a response.
scopestringThe OAuth scopes to request when users authorize the connector.
token_urlstringrequiredThe OAuth 2.0 /token endpoint to use when users authorize the connector.
organization_idstringThe organization to which this connector belongs. This is automatically set to the organization of the user who created the connector.
updated_atstring · date-timerequiredThe UTC time at which the connector was last updated.
urlstringThe URL of the connector that will be used to search for documents.
total_countnumberTotal number of connectors.
{
"connectors": [
{
"active": true,
"auth_status": "expired",
"auth_type": "string",
"continue_on_failure": true,
"created_at": "2026-06-09T00:00:00Z",
"description": "string",
"excludes": [
"string"
],
"id": "string",
"name": "string",
"oauth": {
"authorize_url": "string",
"client_id": "string",
"client_secret": "",
"scope": "string",
"token_url": "string"
},
"organization_id": "string",
"updated_at": "2026-06-09T00:00:00Z",
"url": "string"
}
],
"total_count": 0
}idstringmessagestring{
"id": "string",
"message": "string"
}idstringmessagestring{
"id": "string",
"message": "string"
}idstringmessagestring{
"id": "string",
"message": "string"
}idstringmessagestring{
"id": "string",
"message": "string"
}idstringmessagestring{
"id": "string",
"message": "string"
}idstringmessagestring{
"id": "string",
"message": "string"
}idstringmessagestring{
"id": "string",
"message": "string"
}idstringmessagestring{
"id": "string",
"message": "string"
}idstringmessagestring{
"id": "string",
"message": "string"
}idstringmessagestring{
"id": "string",
"message": "string"
}idstringmessagestring{
"id": "string",
"message": "string"
}idstringmessagestring{
"id": "string",
"message": "string"
}