> ## Documentation Index
> Fetch the complete documentation index at: https://docs.neoagent.io/llms.txt
> Use this file to discover all available pages before exploring further.

# List the tenant's API proxy routes

> Every integration whose vendor calls can go through a reverse proxy you host, with its route or `base_url: null`. `vendor_hosts` lists the hosts whose calls take the route, `secrets` each placeholder and where your proxy swaps it. Header values are never returned.



## OpenAPI

````yaml https://api.neoagent.io/public-api/openapi.json get /public-api/integrations/api-proxy
openapi: 3.1.0
info:
  description: >-
    Neo's public contract for the dashboard ChatAgent, partner integrations, and
    MSP automation. Every response is wrapped in a `{data, meta}` envelope;
    errors use `{error: {code, message, details?}, meta: {request_id}}`.
    Authenticate with a `Bearer neo_sk_<env>_<secret>` API key (service account)
    or a Microsoft Entra ID JWT (dashboard user). Signed-URL endpoints (end-user
    feedback links) take a `signature` query parameter instead.
  title: Neo Public API
  version: 1.0.0
servers:
  - url: https://api.neoagent.io
security: []
tags:
  - description: Service metadata — health, OpenAPI.
    name: Meta
  - description: Agents and workflows — read, version history, delete, stats.
    name: Agents
  - description: Agent/workflow execution history, sub-resources, retry/cancel.
    name: Executions
  - description: >-
      Every tool call the tenant's agents made in the last 30 days, within the
      caller's workflow access.
    name: Audit Log
  - description: PSA webhook events and their workflow-match results.
    name: Callbacks
  - description: Technician-in-the-loop approval requests.
    name: TIL requests
  - description: RMM script executions triggered by agents.
    name: RMM scripts
  - description: Dispatch-agent field-update decisions.
    name: Dispatch
  - description: The authenticated tenant.
    name: Tenant
  - description: Agent-builder schema catalogs (raw JSON payloads).
    name: Schemas
  - description: Escalate to the Neo team (HubSpot ticket).
    name: Escalation
  - description: Tenant settings.
    name: Settings
  - description: Tenant API-key management (dashboard JWT only).
    name: API keys
  - description: End-user feedback links (signed-URL auth).
    name: Feedback
  - description: End-client companies (CRUD + bulk-update).
    name: End companies
  - description: Channels — bind a CONVERSATIONAL agent to a transport (Teams or Slack).
    name: Channels
  - description: PSA/RMM/M365 integration status and connection management.
    name: Integrations
  - description: Technician roster (controls TIL routing and paging).
    name: Technicians
  - description: Future runs queued for TRIGGERED agents.
    name: Scheduled work
  - description: Subscription state and customer-facing credit usage (no provider $).
    name: Billing
  - description: Inbox messages and announcements.
    name: Inbox & Comms
  - description: Tenant-authored agent skills (CRUD) and the built-in skill catalog.
    name: Skills
paths:
  /public-api/integrations/api-proxy:
    get:
      tags:
        - Integrations
      summary: List the tenant's API proxy routes
      description: >-
        Every integration whose vendor calls can go through a reverse proxy you
        host, with its route or `base_url: null`. `vendor_hosts` lists the hosts
        whose calls take the route, `secrets` each placeholder and where your
        proxy swaps it. Header values are never returned.
      operationId: public_api.api_proxy_list_get
      parameters: []
      responses:
        '200':
          content:
            application/json:
              schema:
                properties:
                  data:
                    items:
                      $ref: '#/components/schemas/PublicApiProxyRoute'
                    type: array
                  meta:
                    $ref: '#/components/schemas/SuccessMeta'
                required:
                  - data
                  - meta
                type: object
          description: Success.
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Bad request — malformed input.
        '401':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Unauthenticated — missing or invalid credentials.
        '403':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Forbidden — authenticated but not allowed.
        '404':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Not found.
        '409':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Conflict — the resource is in a state that blocks this operation.
        '422':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Request validation failed.
        '429':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Rate limited — see Retry-After.
        '500':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
          description: Internal server error.
      security:
        - bearerAuth: []
components:
  schemas:
    PublicApiProxyRoute:
      description: One integration's route through the MSP's own API proxy.
      properties:
        auth_header_names:
          description: >-
            The headers Neo sends to authenticate to your proxy. Their values
            are never returned.
          items:
            type: string
          title: Auth Header Names
          type: array
        base_url:
          anyOf:
            - type: string
            - type: 'null'
          description: >-
            The proxy's base URL. Neo sends each call to a vendor host below to
            `<base_url>/<vendor host>/<path>?<query>`. Null when the calls go to
            the vendor directly.
          title: Base Url
        example:
          $ref: '#/components/schemas/PublicProxyExampleCall'
          description: >-
            One call that carries the integration's secrets: each header and
            body as Neo sends it to your proxy (`sent`), and as your proxy must
            send it to the vendor (`forwarded`).
        integration_id:
          description: The integration, as `/integrations` names it.
          title: Integration Id
          type: string
        secrets:
          description: >-
            Each secret the integration sends: the Setup field that holds it,
            the placeholder Neo stores there while the route is on, and where
            your proxy swaps it for the real key.
          items:
            $ref: '#/components/schemas/PublicProxySecret'
          title: Secrets
          type: array
        updated_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When the route was last set; null when none is set.
          title: Updated At
        updated_by:
          anyOf:
            - type: string
            - type: 'null'
          description: Who last set the route; null when none is set.
          title: Updated By
        vendor_hosts:
          description: >-
            The vendor hosts whose calls take the route. `*.example.com` stands
            for every subdomain.
          items:
            type: string
          title: Vendor Hosts
          type: array
        worker_recipe:
          additionalProperties:
            additionalProperties: true
            type: object
          description: >-
            The integration's entries for the `RECIPES` setting of the reference
            Cloudflare Worker in the docs.
          title: Worker Recipe
          type: object
      required:
        - integration_id
        - base_url
        - updated_by
        - updated_at
        - auth_header_names
        - vendor_hosts
        - secrets
        - worker_recipe
        - example
      title: PublicApiProxyRoute
      type: object
    SuccessMeta:
      properties:
        pagination:
          $ref: '#/components/schemas/Pagination'
        request_id:
          format: uuid
          type: string
        timings_ms:
          additionalProperties:
            type: number
          type: object
        warnings:
          description: >-
            Non-fatal warnings about the created/updated resource (e.g. an
            unhealthy PSA callback).
          items:
            type: string
          type: array
      required:
        - request_id
        - timings_ms
      type: object
    ErrorEnvelope:
      properties:
        error:
          properties:
            code:
              description: Stable machine-readable error code.
              type: string
            details:
              additionalProperties: true
              type: object
            message:
              type: string
          required:
            - code
            - message
          type: object
        meta:
          properties:
            request_id:
              format: uuid
              type:
                - string
                - 'null'
          type: object
      required:
        - error
        - meta
      type: object
    PublicProxyExampleCall:
      description: One call of the integration before and after your proxy.
      properties:
        body_forwarded:
          anyOf:
            - type: string
            - type: 'null'
          title: Body Forwarded
        body_sent:
          anyOf:
            - type: string
            - type: 'null'
          title: Body Sent
        headers:
          items:
            $ref: '#/components/schemas/PublicProxyExampleHeader'
          title: Headers
          type: array
        host:
          description: The vendor host; Neo sends the call to `<base_url>/<host><path>`.
          title: Host
          type: string
        method:
          title: Method
          type: string
        path:
          title: Path
          type: string
      required:
        - method
        - host
        - path
        - headers
        - body_sent
        - body_forwarded
      title: PublicProxyExampleCall
      type: object
    PublicProxySecret:
      description: One secret of the integration and where your proxy swaps it.
      properties:
        form_field:
          description: The field on the integration's Setup form.
          title: Form Field
          type: string
        kind:
          description: >-
            HEADER, BASIC (inside `Authorization: Basic`) or BODY (a token
            call's body).
          title: Kind
          type: string
        label:
          title: Label
          type: string
        placeholder:
          description: What Neo sends instead of the real key.
          title: Placeholder
          type: string
        where:
          description: Where the placeholder travels in the request.
          title: Where
          type: string
      required:
        - form_field
        - label
        - placeholder
        - kind
        - where
      title: PublicProxySecret
      type: object
    Pagination:
      properties:
        has_more:
          type: boolean
        next_cursor:
          type:
            - string
            - 'null'
      required:
        - next_cursor
        - has_more
      type: object
    PublicProxyExampleHeader:
      description: One header of the example call.
      properties:
        forwarded:
          title: Forwarded
          type: string
        name:
          title: Name
          type: string
        sent:
          title: Sent
          type: string
      required:
        - name
        - sent
        - forwarded
      title: PublicProxyExampleHeader
      type: object
  securitySchemes:
    bearerAuth:
      description: >-
        `Authorization: Bearer <token>` where `<token>` is either a
        `neo_sk_<env>_<secret>` API key (service account) or a Microsoft Entra
        ID access token (dashboard user).
      scheme: bearer
      type: http

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.