AgencyZoom Life and Health Lead Management API

openapi: 3.2.0
info:
  title: Agencyzoom Life and Health Lead Management API
  description: 'Agencyzoom API enables third party applications to integrate with

    Agencyzoom to manage lead, customer, policy, and tasks. The management operations

    include actions such as creation, retrieval, updating, and deletion.


    Currently, Agencyzoom has a rate limit of **120** calls per minute during the day and night as of Aug 17, 2026.


    # Getting Started

    Using authentication endpoints as described below, the integrator can function on hehalf

    of the logged in user. The login endpoint returns a JWT token. Subsequent calls need

    pass the token as HTTP header bearer token.

    ```

    Authorization: Bearer

    ```

    Please note, the permissions afforded to the caller are the same as those for the logged

    in user. Therefore, the user name used for the integration has to be the agency owner

    if the integrated applications would like to access all the functionalities.


    # Versioning

    Agencyzoom API is backward compatible. Currently there is only one version.


    # Change Logs

    - ### 2023.11.07

    - POST v1/api/leads/list. Fixed bug in sort by `lastActivityDate`. Added 2 additional filters: lastActivityEarliestDate,lastActivityLatestDate

    - Increased rate limite for nightly API calls

    - POST v1/api/leads/{leadId}/quotes. Fixed bug of missing `Quote ID` response payload

    - ### 2023.11.21

    - Increased rate limite for daily API calls to 30 per minute

    - POST /v1/api/leads/{leadId}/notes. Fixed bug in processing line breaks

    - ### 2024.01.10

    - New API for contact management - Batch Create Contacts POST `v1/api/contact/batch-create`

    - Added the following new fields for PUT `v1/api/customers/{customerId}`

    `contactFirstname` `contactLastname` `contactMiddlename` `numberOfEmployees` `annualRevenue` `totalPayroll` `tagNamesbirthday` `csrId` `agentId` `customFields`

    - ### 2024.01.18

    - New API for Customer management - Get AMS policies for a specific customer `GET: v1/api/customers/{customerId}/ams-policies`

    - New API for Customer management - Get policies for a specific customer `GET: v1/api/customers/{customerId}/policies`

    - New API for Customer management - Update tags for a specific policy `POST: v1/api/policies/update-tags`


    - ### 2024.01.18

    - POST `/v1/api/leads/create`. Edit request params `pipelineId` `stageId` as required.

    - ### 2024.03.10

    - Added two new fields `licenseNumber` `stateLicensed` for POST `v1/api/opportunities/{opportunityId}/driver` GET `v1/api/opportunities/drivers/{driverId}` PUT `v1/api/opportunities/drivers/{driverId}`

    - ### 2026.08.7

    - Increased rate limite for daily API calls to 90 per minute

    - ### 2026.08.17

    - Increased rate limite for daily API calls to 120 per minute


    Happy coding!'
  termsOfService: https://agencyzoom.com/tos/
  contact:
    email: support@agencyzoom.com
  license:
    name: Propriety license
  version: 1.0.0
servers:
- url: https://api.agencyzoom.com
  description: Mobile test server
tags:
- name: Life and Health Lead Management
paths:
  /v1/api/life:
    post:
      tags:
      - Life and Health Lead Management
      summary: Search life and health leads
      operationId: searchLifeHealthLead
      requestBody:
        description: Life and health lead search request
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/LifeSearchRequest'
      responses:
        '400':
          description: Invalid request parameter(s)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '500':
          description: Internal processing error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '200':
          description: Retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/LifeSearchResponse'
      security:
      - bearer: []
components:
  schemas:
    BaseSearchResponse:
      properties:
        totalCount:
          type: integer
          example: 100
        page:
          type: integer
          example: 1
        pageSize:
          type: integer
          example: 50
      type: object
    LifeSearchRequest:
      description: Life data request model
      allOf:
      - $ref: '#/components/schemas/BaseSearchRequest'
      - properties:
          agentId:
            description: Producer/agent ID who should get the credit
            type: integer
          efsId:
            description: Life & Health professional ID
            type: integer
          status:
            description: 'A list of status. 0: new, 1: sold, 2: cancelled, 3: no deal, 4: follow up scheduled, 5: no show, 6: not issued, 7: app submitted, 8: quoted'
            type: array
            items:
              type: integer
              enum:
              - 0
              - 1
              - 2
              - 3
              - 4
              - 5
              - 6
              - 7
              - 8
            example:
            - 0
            - 4
          start:
            description: Start date
            type: string
            example: '2019-01-01'
          end:
            description: End date
            type: string
            example: '2019-01-01'
          startCreate:
            description: Start creation date
            type: string
            example: '2019-01-01'
          endCreate:
            description: End creation date
            type: string
            example: '2019-01-01'
          customerLastname:
            description: Customer's last name
            type: string
          soldStartDate:
            description: Sold start date
            type: string
            example: '2019-01-01'
          soldEndDate:
            description: Sold end date
            type: string
            example: '2019-01-01'
          locationId:
            description: The number of the agency
            type: string
            example: '2019-01-01'
          customerEmail:
            description: Customer's email address
            type: string
          customerPhone:
            description: Customer's phone number
            type: string
          keptOnly:
            description: Kept only
            type: boolean
          setOnly:
            description: Set only
            type: boolean
    AlrapptsSummary:
      description: Alrppts and household
      properties:
        id:
          description: The appointments id. (i.e. alrtAppt.id)
          type: integer
          example: 1
        apptTime:
          description: The appointment time
          type: string
          example: '2019-04-11 00:00:00'
        nextApptTime:
          description: Next appointment time
          type: string
          example: '2019-04-11 00:00:00'
        apptType:
          description: Appointment type. 1 - phone, 2 - face to face
          type: integer
          enum:
          - 1
          - 2
          example: 1
        agentId:
          description: The agent's id
          type: integer
          example: 1
        householdId:
          description: The household's id
          type: integer
          example: 1
        ips:
          description: IPS
          type: integer
          example: 1
        productCredit:
          description: Product credit
          type: number
          example: 1
        points:
          description: Points
          type: integer
          example: 1
        efsId:
          description: The efs's id
          type: integer
          example: 1
        agencyId:
          description: The agency's id
          type: integer
          example: 1
        agencyName:
          description: The agency's name
          type: string
          example: AgencyZoom
        assignTo:
          description: The assignee's id
          type: integer
          example: 1
        location:
          description: The location name
          type: string
          example: Location
        status:
          description: "List of status: 0 - new, 1 - sold, 2 - cancel, 3 - no deal, 4 - follow up,\n    5 - no show, 6 - not issued, 7 - submitted, 8 - quoted, 100 - kept"
          type: array
          items:
            type: integer
            enum:
            - 0
            - 1
            - 2
            - 3
            - 4
            - 5
            - 6
            - 7
            - 8
            - 100
          example:
          - 0
          - 4
        createDate:
          description: The creation date
          type: string
          example: '2019-04-12 02:58:34'
        soldDate:
          description: The sold date
          type: string
          example: '2019-04-12 02:58:34'
        appSubmitDate:
          description: The appointment submit date
          type: string
          example: '2019-04-12'
        soldPolicyType:
          description: The sold policy type
          type: string
          example: VOYA
        trackerCustomerName:
          description: Tracker customer name
          type: string
          example: Davi Cooper
        salesTrackerOnly:
          description: Sales tracker only? 1 - yes, 0 - false
          type: integer
          example: 1
        followUpDate:
          description: The follow up date
          type: string
          example: '2019-04-12'
        kept:
          description: Kept or not? 1 - yes, 0 - false
          type: integer
          example: 1
        insCompanyId:
          description: Insurance company id
          type: integer
          example: 1
        appQuoteDate:
          description: The appointment's quote date
          type: string
          example: '2019-04-12'
        leadSourceId:
          description: The lead source id
          type: integer
          example: 1
        housename:
          description: The house name
          type: string
          example: Davi Cooper
        customerFirstname:
          description: The customer's first name
          type: string
          example: Davi
        customerLastname:
          description: The customer's last name
          type: string
          example: Cooper
        customerPhone:
          description: The customer's phone number
          type: string
          example: (111) 111-1111
        customerEmail:
          description: The customer's email address
          type: string
          example: example@gmail.com
        agencyNumber:
          description: The agency or branch's assigned id
          type: string
          example: A0A0001
        agentFirstname:
          description: The agent's first name
          type: string
          example: Davi
        agentLastname:
          description: The agent's last name
          type: string
          example: Cooper
        efsFirstname:
          description: The efs's first name
          type: string
          example: Davi
        efsLastname:
          description: The efs's last name
          type: string
          example: Cooper
        creatorFirstname:
          description: The creator's first name
          type: string
          example: Davi
        creatorLastname:
          description: The creator's last name
          type: string
          example: Cooper
        carrier:
          description: The insurance company's short name
          type: string
          example: Ace
      type: object
    ErrorResponse:
      description: Error response model.
      properties:
        error:
          description: The error message
          type: string
        fieldErrors:
          description: The field errors
          type: array
          items:
            $ref: '#/components/schemas/FieldError'
      type: object
    FieldError:
      description: Form field error model.
      properties:
        field:
          description: The field ID
          type: string
        error:
          description: The error message
          type: string
      type: object
    BaseSearchRequest:
      properties:
        pageSize:
          description: 'Page size:  number of results returned. The maximum is 500'
          type: integer
          default: 20
          example: 20
        page:
          description: The page being returned. Start with 0
          type: integer
          default: 0
          example: 0
        sort:
          description: Field name used for sorting
          type: string
          example: id
        order:
          type: string
          enum:
          - asc
          - desc
        location:
          description: Location ID
          type: string
      type: object
    LifeSearchResponse:
      description: Life data response model
      required:
      - agencyId
      - status
      allOf:
      - $ref: '#/components/schemas/BaseSearchResponse'
      - properties:
          alrLeads:
            description: The appointment list
            type: array
            items:
              $ref: '#/components/schemas/AlrapptsSummary'
  securitySchemes:
    bearer:
      type: http
      bearerFormat: JWT
      scheme: bearer
x-provenance:
  method: harvested
  publisher: AgencyZoom
  source: https://app.agencyzoom.com/openapi/agencyzoom.yaml
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)