> ## 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.

# List Connector Tools

> Lists the tool operations defined under `connectorId` that the agent can use to call the external service.



## OpenAPI

````yaml /openapi/endpoints/meta-business-agent-public.openapi.json get /metaBusinessAgents/{entityId}/connectors/{connectorId}/tools
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}/tools:
    get:
      tags:
        - Meta Business Agents
      summary: List Connector Tools
      description: >-
        Lists the tool operations defined under `connectorId` that the agent can
        use to call the external service.
      operationId: meta-business-agent-list-connector-tools
      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:
                type: array
                items:
                  $ref: '#/components/schemas/ConnectorToolDTO'
        '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:
    ConnectorToolDTO:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        description:
          type: string
        request_definition:
          $ref: '#/components/schemas/ConnectorToolRequestDefinitionDTO'
        user_auth_required:
          type: boolean
        user_auth_action_config:
          $ref: '#/components/schemas/ConnectorToolUserAuthActionConfigDTO'
        transformation_spec:
          $ref: '#/components/schemas/ConnectorToolTransformationSpecDTO'
      additionalProperties: false
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          $ref: '#/components/schemas/Error'
    ConnectorToolRequestDefinitionDTO:
      type: object
      properties:
        method:
          type: string
          minLength: 1
          enum:
            - GET
            - POST
            - PUT
            - DELETE
            - PATCH
        path:
          type: string
          minLength: 1
        path_parameters:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ParameterNodeDTO'
        query_parameters:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ParameterNodeDTO'
        headers:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/ParameterNodeDTO'
        body:
          $ref: '#/components/schemas/RequestBodyDefinitionDTO'
      required:
        - method
        - path
      additionalProperties: false
    ConnectorToolUserAuthActionConfigDTO:
      type: object
      properties:
        user_action_tool_type:
          type: string
          minLength: 1
          enum:
            - auth
            - refresh
        user_auth_token_path:
          type: string
          minLength: 1
        refresh_token_path:
          type: string
        expires_at_path:
          type: string
        expires_at_type:
          type: string
          enum:
            - absolute
            - relative_seconds
      required:
        - user_action_tool_type
        - user_auth_token_path
      additionalProperties: false
    ConnectorToolTransformationSpecDTO:
      type: object
      nullable: true
      required:
        - version
        - steps
      properties:
        version:
          type: integer
          enum:
            - 1
        steps:
          type: array
          maxItems: 5
          items:
            $ref: '#/components/schemas/ConnectorToolTransformationStepDTO'
      additionalProperties: false
      description: >-
        Ordered response transformation. On create, omission or null means no
        transformation. On update, omission preserves the current
        transformation, null deletes it, and an object sets it. Responses
        contain Meta’s returned configuration; absence does not confirm a
        submitted configuration.
    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.
    ParameterNodeDTO:
      type: object
      properties:
        type:
          type: string
        description:
          type: string
        required:
          type: boolean
        binding:
          $ref: '#/components/schemas/ParameterBindingDTO'
      additionalProperties: false
    RequestBodyDefinitionDTO:
      type: object
      properties:
        content_type:
          type: string
          minLength: 1
          enum:
            - application/json
        params:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/BodyNodeDTO'
        required:
          type: array
          items:
            type: string
      required:
        - content_type
        - params
      additionalProperties: false
    ConnectorToolTransformationStepDTO:
      type: object
      required:
        - kind
      properties:
        kind:
          type: string
          enum:
            - allowlist
            - case
            - catalog
            - decorate_url
            - dedupe
            - dehydrate
            - filter
            - first_nonempty
            - first_nonnull
            - first_nonzero
            - format
            - html_escape
            - lookup
            - math
            - proxy_image
            - reshape
            - shadow_allowlist
            - string_replace
            - truncate
        target:
          type: string
          nullable: true
        params:
          type: string
          nullable: true
          description: >-
            Kind-specific parameters as a JSON object encoded in a string. A
            math expression supports at most four nested levels. Parameters are
            forwarded without evaluation or rewriting.
      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.
    ParameterBindingDTO:
      type: object
      properties:
        kind:
          type: string
        value:
          type: string
        macro:
          type: string
          enum:
            - WHATSAPP_PHONE_NUMBER
            - WHATSAPP_PHONE_NUMBER_NATIONAL
            - WHATSAPP_IDENTITY_HASH
            - WHATSAPP_CURRENT_STATUS_ID
            - WHATSAPP_BSUID
            - USER_MESSAGE
            - WHATSAPP_CONVERSATION_ID
            - WHATSAPP_MESSAGE_ID
            - INSTAGRAM_IGSID
            - INSTAGRAM_CONVERSATION_ID
          description: >-
            Official binding macro. Accepting an Instagram macro does not enable
            Instagram entities or guarantee its value for WhatsApp consumers.
      additionalProperties: false
    BodyNodeDTO:
      type: object
      properties:
        type:
          type: string
        description:
          type: string
        required:
          type: array
          items:
            type: string
        properties:
          type: object
          additionalProperties:
            type: string
        items:
          type: string
        binding:
          $ref: '#/components/schemas/ParameterBindingDTO'
      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.