> ## Documentation Index > Fetch the complete documentation index at: https://docs.ycloud.com/llms.txt > Use this file to discover all available pages before exploring further. # Get Connector > Retrieves the external API connector identified by `connectorId`. ## OpenAPI ````yaml /openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/connectors/{connectorId} openapi: 3.0.0 info: title: YCloud Meta Business Agent Public API version: v2 description: >- Create, configure, test, and operate a Meta Business Agent for a WhatsApp Business phone number through YCloud. servers: - url: https://api.ycloud.com/v2 description: YCloud API base URL security: - api_key: [] tags: - name: Meta Business Agents description: >- Meta Business Agent onboarding, knowledge, skills, connectors, tools, operations, and evaluations. paths: /metaBusinessAgents/{entityId}/connectors/{connectorId}: get: tags: - Meta Business Agents summary: Get Connector description: Retrieves the external API connector identified by `connectorId`. operationId: meta-business-agent-get-connector parameters: - name: entityId in: path required: true schema: type: string description: WhatsApp Business Phone Number ID that owns the Meta Business Agent. - name: connectorId in: path required: true schema: type: string description: Connector resource ID. responses: '200': description: Operation completed successfully. content: application/json: schema: $ref: '#/components/schemas/ConnectorDTO' '400': description: Request failed. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: Request failed. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '403': description: Request failed. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '404': description: Request failed. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '409': description: Request failed. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '429': description: Request failed. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '500': description: Request failed. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '502': description: Request failed. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' components: schemas: ConnectorDTO: type: object properties: id: type: string name: type: string description: type: string base_url: type: string auth_type: type: string enum: - OAUTH2 - OAUTH2_CLIENT_CREDENTIALS - API_KEY - BASIC - CUSTOM - NONE auth_config: $ref: '#/components/schemas/ConnectorAuthConfigDTO' mtls_config: $ref: '#/components/schemas/MtlsConfigDTO' connection_status: $ref: '#/components/schemas/ConnectionStatusDTO' user_auth_injection_config: $ref: '#/components/schemas/UserAuthInjectionConfigDTO' connector_protocol: type: string enum: - HTTP - MCP description: >- Connector protocol. Omit on creation to use Meta’s HTTP default. The protocol cannot change after creation; omit on update to preserve it. nullable: true mcp_tool_sync: $ref: '#/components/schemas/ConnectorMcpToolSyncDTO' additionalProperties: false ErrorResponse: type: object required: - error properties: error: $ref: '#/components/schemas/Error' ConnectorAuthConfigDTO: type: object properties: oauth2_client_credentials: $ref: '#/components/schemas/OAuth2ClientCredentialsDTO' api_key: $ref: '#/components/schemas/ApiKeyDTO' additionalProperties: false MtlsConfigDTO: type: object properties: has_certificate: type: boolean fingerprint: type: string expires_at: type: integer format: int64 subject: type: string client_certificate: type: string ca_certificate: type: string additionalProperties: false ConnectionStatusDTO: type: object properties: status: type: string enum: - PENDING_OAUTH - ACTIVE - EXPIRED - ERROR error_message: type: string additionalProperties: false UserAuthInjectionConfigDTO: type: object properties: location: type: string minLength: 1 enum: - body - headers - path - query field_name: type: string minLength: 1 prefix: type: string minLength: 1 additionalProperties: false required: - location - field_name - prefix ConnectorMcpToolSyncDTO: type: object nullable: true required: - status properties: status: type: string enum: - ERROR - PENDING - READY description: >- Tool discovery state. ERROR indicates discovery failure even when the connector operation succeeds. last_attempted_at: type: integer format: int64 nullable: true description: Last discovery attempt, in Unix seconds. last_successful_at: type: integer format: int64 nullable: true description: Last successful discovery, in Unix seconds. fingerprint: type: string nullable: true tool_count: type: integer nullable: true additionalProperties: false Error: type: object required: - status - code properties: status: type: integer format: int32 pattern: '[45]\d{2}' description: >- HTTP status code, [RFC 7231, Section 6](https://datatracker.ietf.org/doc/html/rfc7231#section-6). It conveys the HTTP status code used for the convenience of the consumer. example: 404 code: type: string description: >- One of a server-defined error codes. Some `4xx` errors that could be handled programmatically include an error code that briefly explains the error reported. example: NOT_FOUND message: type: string description: >- A human-readable representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users. example: The requested resource does not exist. target: type: string description: The target of the error. example: '' docUrl: type: string description: A URL to more information about the error. example: '' requestId: type: string description: >- Each API request has an associated request ID. It conveys the response header `YCloud-Request-ID` used for the convenience of the consumer. example: req_1KjtKI80IKoaJNa6n6p whatsappApiError: $ref: '#/components/schemas/WhatsappApiError' description: >- The original error object returned by WhatsApp. See [Handling Errors](https://developers.facebook.com/docs/graph-api/guides/error-handling), [Cloud API Error Codes](https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes). Note: This field is returned if we tried to request the WhatsApp Business API and got an error response. metaBusinessAgentApiError: $ref: '#/components/schemas/MetaBusinessAgentApiError' description: >- Sanitized upstream details returned when a Meta Business Agent request fails. OAuth2ClientCredentialsDTO: type: object properties: token_url: type: string minLength: 1 scopes_to_request: type: array items: type: string token_request_content_type: type: string enum: - application/x-www-form-urlencoded - application/json client_id: type: string minLength: 1 client_secret: type: string minLength: 1 writeOnly: true required: - token_url - scopes_to_request - client_id - client_secret additionalProperties: false ApiKeyDTO: type: object properties: headers: type: array items: $ref: '#/components/schemas/ApiKeyParamDTO' query_params: type: array items: $ref: '#/components/schemas/ApiKeyParamDTO' body_params: type: array items: $ref: '#/components/schemas/ApiKeyParamDTO' anyOf: - required: - headers properties: headers: minItems: 1 - required: - query_params properties: query_params: minItems: 1 - required: - body_params properties: body_params: minItems: 1 description: >- At least one item is required across headers, query_params, and body_params. additionalProperties: false WhatsappApiError: type: object description: >- The original error object returned by WhatsApp. See [Handling Errors](https://developers.facebook.com/docs/graph-api/guides/error-handling), [Cloud API Error Codes](https://developers.facebook.com/docs/whatsapp/cloud-api/support/error-codes). required: - message - code properties: message: type: string description: A human-readable description of the error. example: HSM Template creation failed code: type: string description: An error code. example: 200002 type: type: string description: Error type. example: OAuthException is_transient: type: boolean description: Whether the error is transient. example: false error_subcode: type: string description: Additional code about the error. example: 2388109 error_user_msg: type: string description: >- The message to display to the user. The language of the message is based on the locale of the API request. example: This message template cannot be created. error_user_title: type: string description: >- The title of the dialog, if shown. The language of the message is based on the locale of the API request. example: Message Cannot Be Submitted fbtrace_id: type: string description: >- Internal support identifier. When reporting a bug related to a Graph API call, include the fbtrace_id to help us find log data for debugging. example: AVGjJ7ia2zJkrHG error_data: type: object description: >- Additional data about the error. A string or map. - For template APIs, this field is a string describing the reason for the error. - For message APIs, this field is a map with property `details` describing the reason for the error. MetaBusinessAgentApiError: type: object additionalProperties: false properties: title: type: string description: Meta error title, when available. detail: type: string description: Actionable Meta error detail, when available. type: type: string description: Meta error category or URI, when available. status: type: integer description: Upstream HTTP status. requestId: type: string description: Upstream request identifier. ApiKeyParamDTO: type: object properties: field_name: type: string minLength: 1 value: type: string minLength: 1 writeOnly: true prefix: type: string required: - field_name - value additionalProperties: false securitySchemes: api_key: type: apiKey in: header name: X-API-Key ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.