WhatsApp · Business Agent

List connectors

Returns connectors.

GEThttps://api.pozy.ai/v1/accounts/{accountId}/business-agent/connectors

listBusinessAgentConnectors

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys can call it. Keys with the messages resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

Name	Type	Notes
`accountId`required	string

Example

curl -X GET "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-agent/connectors" \
  -H "Authorization: Bearer $POZY_API_KEY"

const res = await fetch("https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-agent/connectors", {
  headers: { Authorization: `Bearer ${process.env.POZY_API_KEY}` },
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.get(
    "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-agent/connectors",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

connectorsarray of objectrequired
12 child fields
- namestringrequired
- descriptionstring
- base_urlstring (URL)required
- connector_protocolstring
- auth_typestringrequired
  One of OAUTH2_CLIENT_CREDENTIALS, API_KEY, NONE.
- auth_configobject
  2 child fields
  oauth2_client_credentialsobject
  5 child fields
  token_urlstring (URL)required
  scopes_to_requestarray of string
  token_request_content_typestring
  client_idstringrequired
  client_secretstringrequired
  api_keyobject
  3 child fields
  headersarray of object
  3 child fields
  field_namestringrequired
  valuestringrequired
  prefixstring
  query_paramsarray of object
  3 child fields
  field_namestringrequired
  valuestringrequired
  prefixstring
  body_paramsarray of object
  3 child fields
  field_namestringrequired
  valuestringrequired
  prefixstring
- user_auth_injection_configobject
  3 child fields
  locationstringrequired
  field_namestringrequired
  prefixstring
- requires_certificateboolean
- idstringrequired
- mcp_tool_syncobject
- mtls_configobject
- connection_statusobject
  2 child fields
  statusstring
  error_messagestring

200 response

{
  "connectors": [
    {
      "name": "Acme",
      "description": "A short description",
      "base_url": "https://pozy.ai/media/example-1.jpg",
      "connector_protocol": "string",
      "auth_type": "OAUTH2_CLIENT_CREDENTIALS",
      "auth_config": {
        "oauth2_client_credentials": {
          "token_url": "https://pozy.ai/media/example-1.jpg",
          "scopes_to_request": [
            "string"
          ],
          "token_request_content_type": "Hello from Pozy",
          "client_id": "6d8e8e36f9a9b90298b622ef",
          "client_secret": "string"
        },
        "api_key": {
          "headers": [
            {
              "field_name": "Acme",
              "value": "string",
              "prefix": "string"
            }
          ],
          "query_params": [
            {
              "field_name": "Acme",
              "value": "string",
              "prefix": "string"
            }
          ],
          "body_params": [
            {
              "field_name": "Acme",
              "value": "string",
              "prefix": "string"
            }
          ]
        }
      },
      "user_auth_injection_config": {
        "location": "string",
        "field_name": "Acme",
        "prefix": "string"
      },
      "requires_certificate": true,
      "id": "6bfebd43ddc270f6d2c56fc5",
      "mcp_tool_sync": {},
      "mtls_config": {},
      "connection_status": {
        "status": "active",
        "error_message": "Hello from Pozy"
      }
    }
  ]
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is scoped to other profiles or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.

More in Business Agent

GETGet agent setup status POSTCreate the agent GETList agent settings PATCHUpdate agent settings GETList allowlisted consumers POSTAllowlist a consumer DELRemove an allowlisted consumer GETGet business information PUTReplace business information DELReset business information GETList FAQs POSTCreate a FAQ GETGet a FAQ PUTUpdate a FAQ DELDelete a FAQ GETList crawled websites POSTAdd a website to crawl GETGet a crawled website PUTUpdate a crawled website DELRemove a crawled website GETList knowledge files POSTUpload a knowledge file GETGet a knowledge file DELDelete a knowledge file GETList skills POSTCreate a skill GETGet a skill PUTUpdate a skill DELDelete a skill GETList UI skills POSTCreate a UI skill GETGet a UI skill PUTUpdate a UI skill DELDelete a UI skill POSTCreate a connector GETGet a connector PUTUpdate a connector DELDelete a connector POSTSet connector credentials POSTRefresh MCP connector tools GETGet connector failure logs GETList connector tools POSTCreate a connector tool GETGet a connector tool PUTUpdate a connector tool DELDelete a connector tool POSTRun a connector tool once GETGet usage budgets PUTReplace usage budgets POSTSend a test message POSTSend a business event GETGet a business event status GETRead evaluation data POSTStart an evaluation run