1Fort Email AI Agent - Businesses API

openapi: 3.2.0
info:
  title: 1Fort API Documentation Email AI Agent - Businesses API
  description: '# 1Fort API


    REST API for the 1Fort insurance platform. This document is the authoritative

    map of the API surface; endpoints are grouped in the sidebar by **app** and

    **version**, and large apps are split into per-resource sub-groups.


    ## Authentication


    Almost every endpoint requires a **JWT access token**. Send it in the

    `Authorization` header as either `Bearer <token>` or `JWT <token>`. Tokens may

    also be presented as an HTTP-only cookie. Endpoints documented with no security

    requirement are intentionally public (for example sign-in, OTP and storefront

    endpoints).


    ## Multi-tenancy


    Resources are scoped to a tenant. Nested routes carry the owning resource id in

    the path (for example `/v2/broker/{business_pk}/applications`); a token is only

    authorised for the businesses its user may access. Object-level permissions are

    enforced per endpoint.


    ## Versioning


    `v2` endpoints live under `/apis/v2/...` and are the current surface. `v1`

    endpoints remain documented for compatibility. Endpoints marked **deprecated**

    are scheduled for removal; prefer the documented replacement.

    '
  termsOfService: https://www.1fort.com/
  license:
    name: Privately owned
  version: v1
servers:
- url: https://api.1fort.com/apis/
security:
- Bearer: []
tags:
- name: Email AI Agent - Businesses
  x-displayName: Businesses
  description: '**Access:** requires a JWT access token.'
paths:
  /v2/broker/agent/businesses/search:
    parameters: []
    get:
      operationId: agent_search_businesses
      summary: Search Businesses
      description: '

        Search the broker''s businesses for linking to profiles.


        All results are scoped to the session''s broker.


        **Query Parameters**:

        - `q`: Full-text search query (searches name and domain)

        - `name`: Filter by name (case-insensitive contains)

        - `name__iexact`: Filter by name (exact match)

        - `domain_name`: Filter by domain

        - `has_profiles`: Filter by having linked EmailInsured profiles

        - `limit`: Results limit (default: 20, max: 100)

        - `offset`: Pagination offset


        **Authentication**: Requires API Key + Session Token

        '
      parameters:
      - name: X-Processing-Session
        in: header
        description: Processing session token (scopes access to broker)
        required: true
        schema:
          type: string
      - name: q
        in: query
        description: Full-text search query (name, domain)
        schema:
          type: string
      - name: name
        in: query
        description: Filter by name (case-insensitive contains)
        schema:
          type: string
      - name: name__iexact
        in: query
        description: Filter by name (exact match)
        schema:
          type: string
      - name: domain_name
        in: query
        description: Filter by domain
        schema:
          type: string
      - name: has_profiles
        in: query
        description: Filter by having linked profiles
        schema:
          type: boolean
      - name: limit
        in: query
        description: 'Results limit (default: 20, max: 100)'
        schema:
          type: integer
      - name: offset
        in: query
        description: Pagination offset
        schema:
          type: integer
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AgentBusinessSearchResult'
        '401':
          description: Unauthorized - Invalid or missing API key or session token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: UNAUTHORIZED
                  message: Invalid or missing authentication credentials
        '403':
          description: Forbidden - Resource belongs to unauthorized broker
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: FORBIDDEN
                  message: Access denied - resource outside session scope
        '500':
          description: Internal server error.
      tags:
      - Email AI Agent - Businesses
  /v2/broker/agent/businesses/{id}:
    parameters:
    - name: id
      in: path
      description: A unique integer value identifying this business.
      required: true
      schema:
        type: integer
    get:
      operationId: agent_get_business
      summary: Get Business
      description: '

        Retrieve detailed business information with linked profiles.


        **Authentication**: Requires API Key + Session Token


        **Scoping**: Business must belong to the session''s broker.

        '
      parameters:
      - name: X-Processing-Session
        in: header
        description: Processing session token (scopes access to broker)
        required: true
        schema:
          type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentBusinessDetail'
        '401':
          description: Unauthorized - Invalid or missing API key or session token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: UNAUTHORIZED
                  message: Invalid or missing authentication credentials
        '403':
          description: Forbidden - Resource belongs to unauthorized broker
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: FORBIDDEN
                  message: Access denied - resource outside session scope
        '404':
          description: Not Found - Resource does not exist
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              example:
                error:
                  code: NOT_FOUND
                  message: Resource not found
        '500':
          description: Internal server error.
      tags:
      - Email AI Agent - Businesses
components:
  schemas:
    AgentBusinessSearchResult:
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        name:
          title: Name
          type: string
          readOnly: true
          minLength: 1
        domain_name:
          title: Domain name
          type:
          - string
          - 'null'
          readOnly: true
          minLength: 1
        industry:
          title: Industry
          type:
          - string
          - 'null'
          readOnly: true
          minLength: 1
        number_of_employees:
          title: Number of employees
          type:
          - integer
          - 'null'
          readOnly: true
        city:
          title: City
          type:
          - string
          - 'null'
          readOnly: true
          minLength: 1
        state_code:
          title: State code
          type:
          - string
          - 'null'
          readOnly: true
          minLength: 1
        linked_profile_count:
          title: Linked profile count
          type: string
          readOnly: true
        active:
          title: Active
          type: boolean
          readOnly: true
    AgentBusinessDetail:
      type: object
      properties:
        id:
          title: ID
          type: integer
          readOnly: true
        name:
          title: Name
          type: string
          readOnly: true
          minLength: 1
        domain_name:
          title: Domain name
          type:
          - string
          - 'null'
          readOnly: true
          minLength: 1
        industry:
          title: Industry
          type:
          - string
          - 'null'
          readOnly: true
          minLength: 1
        number_of_employees:
          title: Number of employees
          type:
          - integer
          - 'null'
          readOnly: true
        revenue:
          title: Revenue
          type:
          - integer
          - 'null'
          readOnly: true
        address:
          title: Address
          type: string
          readOnly: true
        phone_number:
          title: Phone number
          type:
          - string
          - 'null'
          readOnly: true
          minLength: 1
        active:
          title: Active
          type: boolean
          readOnly: true
        linked_profiles:
          type: array
          items:
            $ref: '#/components/schemas/AgentBusinessLinkedProfile'
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
        updated_at:
          title: Updated at
          type: string
          format: date-time
          readOnly: true
    AgentBusinessLinkedProfile:
      type: object
      properties:
        id:
          title: Id
          type: string
          readOnly: true
          minLength: 1
        insured:
          title: Insured
          type: string
          readOnly: true
          minLength: 1
        domains:
          title: Domains
          type: object
          readOnly: true
        created_at:
          title: Created at
          type: string
          format: date-time
          readOnly: true
    ErrorResponse:
      required:
      - error
      type: object
      properties:
        error:
          title: Error
          description: Error details with code and message.
          type: object
          additionalProperties:
            type: string
            minLength: 1
        request_id:
          title: Request id
          description: Request ID for debugging.
          type: string
          minLength: 1
        timestamp:
          title: Timestamp
          description: When the error occurred.
          type: string
          format: date-time
  securitySchemes:
    Bearer:
      type: apiKey
      name: Authorization
      in: header
      description: JWT access token. Send as `Bearer <token>` or `JWT <token>`.
    ApiKey:
      type: apiKey
      name: Authorization
      in: header
      description: API key. Send as `Api-Key <key>`.
x-tagGroups:
- name: Agent runtime (v2)
  tags:
  - agent_runtime (v2)
- name: Analytics
  tags:
  - analytics
- name: Application
  tags:
  - 'application: applications'
  - 'application: clients'
- name: Application (v2)
  tags:
  - 'application (v2): applications'
  - 'application (v2): coverages'
- name: Ascend
  tags:
  - ascend
- name: Ascend (v2)
  tags:
  - ascend (v2)
- name: Authentication
  tags:
  - Authentication
  - auth
- name: Billing (v2)
  tags:
  - billing (v2)
- name: Broker
  tags:
  - broker
  - broker-ams-integration
  - broker-google
  - broker-office365
  - broker-office365-individual
  - 'broker: ai-customization-types'
  - 'broker: ai-customizations'
  - 'broker: clients'
  - 'broker: email_preferences'
  - 'broker: proposal-preferences'
  - 'broker: take-rates'
  - 'broker: user-ai-customizations'
  - 'broker: users'
  - broker_groups
  - broker_settings
- name: Broker (v2)
  tags:
  - 'broker (v2): applications'
  - 'broker (v2): clients'
  - 'broker (v2): coverages'
  - 'broker (v2): email-templates'
  - 'broker (v2): quote-policies'
  - 'broker (v2): quotes'
  - 'broker (v2): storefront'
  - 'broker (v2): team-users'
- name: Business
  tags:
  - business
  - business-broker-users
  - business-user
  - business_admin
- name: Carrier
  tags:
  - carrier
- name: Checkout
  tags:
  - checkout
- name: Email AI
  tags:
  - email_ai
- name: Email AI (v2)
  tags:
  - 'email_ai (v2): attachments'
  - 'email_ai (v2): carriers'
  - 'email_ai (v2): coverage-types'
  - 'email_ai (v2): emails'
  - 'email_ai (v2): gmail'
  - 'email_ai (v2): office365'
  - 'email_ai (v2): profiles'
  - 'email_ai (v2): wholesalers'
- name: Email AI Agent
  tags:
  - Email AI Agent
  - Email AI Agent - Attachments
  - Email AI Agent - Businesses
  - Email AI Agent - Entities
  - Email AI Agent - Markets
  - Email AI Agent - Profiles
  - Email AI Agent - Reference Data
- name: Google workspace (v2)
  tags:
  - google_workspace (v2)
- name: Herald (v2)
  tags:
  - herald (v2)
- name: Indications (v2)
  tags:
  - indications (v2)
- name: Insurance (v2)
  tags:
  - insurance (v2)
- name: Invite
  tags:
  - invite
- name: Legal
  tags:
  - legal
- name: Market
  tags:
  - Markets
  - Markets - Business
- name: Market (v2)
  tags:
  - market (v2)
- name: Office365 (v2)
  tags:
  - office365 (v2)
- name: Premium finance (v2)
  tags:
  - premium_finance (v2)
- name: Quote
  tags:
  - 'quote: applications'
  - 'quote: clients'
  - 'quote: quotes'
- name: Quote (v2)
  tags:
  - 'quote (v2): application'
  - 'quote (v2): binders'
  - 'quote (v2): checkout'
  - 'quote (v2): cios'
  - 'quote (v2): coverages'
  - 'quote (v2): quote-policies'
  - 'quote (v2): quotes'
  - 'quote (v2): tasks'
  - quote_ai (v2)
- name: Reports
  tags:
  - reports
- name: Reward
  tags:
  - reward
- name: Risk manager
  tags:
  - risk_manager
- name: Sanity check AI
  tags:
  - sanity_check_ai
- name: Storefront (v2)
  tags:
  - storefront (v2)
- name: Stripe
  tags:
  - stripe
- name: Suggestion AI
  tags:
  - suggestion_ai
- name: Treasury (v2)
  tags:
  - treasury (v2)
- name: User
  tags:
  - user
  - 'user: default-access-role'