HOVER Capture Requests API

The Capture Requests API from HOVER — 6 operation(s) for capture requests.

Operations 7

GET /api/v2/capture_requests List Capture Requests #
POST /api/v2/capture_requests Create a Capture Request #
GET /api/v2/capture_requests/exists Check for Existing Capture Request #
DELETE /api/v2/capture_requests/{capture_request_id} Delete Capture Request #
POST /api/v2/capture_requests/{capture_request_id}/resend_notifications Resend Capture Request Notifications #
GET /api/v2/capture_requests/{id}/details Get api v2 capture requests id details #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/hover:hover-capture-requests-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

hover-capture-requests-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: hover-api-v3 Capture Requests API
  version: '3'
servers:
- url: https://hover.to
security:
- sec0: []
tags:
- name: Capture Requests
paths:
  /api/v2/capture_requests:
    get:
      summary: List Capture Requests
      description: ''
      operationId: list-capture-requests
      parameters:
      - name: current_user_id
        in: query
        description: Required. The ID of a user within the authenticated organization. Returns capture requests associated with this user.
        schema:
          type: integer
          format: int32
          default: 8675309
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Capture Requests
    post:
      summary: Create a Capture Request
      description: ''
      operationId: create-capture-request
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                capture_request:
                  properties:
                    capturing_user_email:
                      type: string
                      description: Required. The email address of the person this capture request will be sent to.
                      default: homeowner@bluthcompanies.com
                    capturing_user_phone:
                      type: string
                      description: Optional. The phone number of the person this capture request will be sent to.
                      default: '8058675309'
                    capturing_user_name:
                      type: string
                      description: Required. The name of the person that will be capturing the property. Most likely the homeowner's name.
                      default: Lucille Bluth
                    signup_type:
                      type: string
                      description: Optional. Defaults to `homeowner`. Allowed values are `homeowner` and `pro`, designated by the type of user capturing the property.
                      default: homeowner
                    job_attributes:
                      properties:
                        name:
                          type: string
                          description: A name for the job.
                          default: The Big House
                        deliverable_id:
                          type: string
                          description: 'Supported deliverable_ids: 2(Roof Only), 3(Complete), 5(Total Living Area Plus), 6 (Total Living Area), 7 (Capture Only, Photos Only), 8 (Interior)'
                          default: '3'
                        external_identifier:
                          type: string
                          description: A unique identifier generated by the client. This can be anything you want and won't be changed. It can be used to reference an ID in the an external system database.
                          default: '8675309'
                        location_city:
                          type: string
                          description: The city where this job is located.
                          default: Denver
                        location_line_1:
                          type: string
                          description: First line of this job's address
                          default: 1701 Bryant Street
                        location_line_2:
                          type: string
                          description: Second line of this job's address
                          default: Apartment 22
                        location_postal_code:
                          type: string
                          description: The postal code of this job's address
                          default: '80204'
                        location_region:
                          type: string
                          description: The 2 character state code where this job resides.
                          default: CO
                        suppress_email:
                          type: boolean
                          description: If a value other than false is given for this attribute then all emails related to this job will be suppressed. That includes capture request emails.
                          default: false
                        wallet_id:
                          type: integer
                          description: Optional. By passing this parameter you can specify the billing information for the job.
                          default: 67821
                          format: int32
                      required: []
                      type: object
                    suppress_text_messages:
                      type: string
                      description: If a value other than false is given for this attribute then all SMS related to this job will be suppressed. That includes capture request SMS..
                      default: 'false'
                    inspection_workflow_id:
                      type: string
                      default: 'null'
                      description: 'An inspection workflow ID to allow the capturing user to perform an inspection (in addition to a scan) upon receiving a Capture Request. '
                  required: []
                  type: object
                current_user_email:
                  type: string
                  description: The internal user that you want to assign the job to. Alternatively, you can also use the `current_user_id` param.
                  default: michael@bluthcompanies.com
                current_user_id:
                  type: integer
                  description: The ID value of the user who you want to assign the job to. Alternatively, current_user_email can be used.
                  default: 643197
                  format: int32
          multipart/form-data:
            schema:
              type: object
              properties:
                capture_request:
                  properties:
                    capturing_user_email:
                      type: string
                      description: Required. The email address of the person this capture request will be sent to.
                      default: homeowner@bluthcompanies.com
                    capturing_user_phone:
                      type: string
                      description: Optional. The phone number of the person this capture request will be sent to.
                      default: '8058675309'
                    capturing_user_name:
                      type: string
                      description: Required. The name of the person that will be capturing the property. Most likely the homeowner's name.
                      default: Lucille Bluth
                    signup_type:
                      type: string
                      description: Optional. Defaults to `homeowner`. Allowed values are `homeowner` and `pro`, designated by the type of user capturing the property.
                      default: homeowner
                    job_attributes:
                      properties:
                        name:
                          type: string
                          description: A name for the job.
                          default: The Big House
                        deliverable_id:
                          type: string
                          description: 'Supported deliverable_ids: 2(Roof Only), 3(Complete), 5(Total Living Area Plus), 6 (Total Living Area), 7 (Capture Only, Photos Only), 8 (Interior)'
                          default: '3'
                        external_identifier:
                          type: string
                          description: A unique identifier generated by the client. This can be anything you want and won't be changed. It can be used to reference an ID in the an external system database.
                          default: '8675309'
                        location_city:
                          type: string
                          description: The city where this job is located.
                          default: Denver
                        location_line_1:
                          type: string
                          description: First line of this job's address
                          default: 1701 Bryant Street
                        location_line_2:
                          type: string
                          description: Second line of this job's address
                          default: Apartment 22
                        location_postal_code:
                          type: string
                          description: The postal code of this job's address
                          default: '80204'
                        location_region:
                          type: string
                          description: The 2 character state code where this job resides.
                          default: CO
                        suppress_email:
                          type: boolean
                          description: If a value other than false is given for this attribute then all emails related to this job will be suppressed. That includes capture request emails.
                          default: false
                        wallet_id:
                          type: integer
                          description: Optional. By passing this parameter you can specify the billing information for the job.
                          default: 67821
                          format: int32
                      required: []
                      type: object
                    suppress_text_messages:
                      type: string
                      description: If a value other than false is given for this attribute then all SMS related to this job will be suppressed. That includes capture request SMS..
                      default: 'false'
                  required: []
                  type: object
                current_user_email:
                  type: string
                  description: The internal user that you want to assign the job to. Alternatively, you can also use the `current_user_id` param.
                  default: michael@bluthcompanies.com
                current_user_id:
                  type: integer
                  description: The ID value of the user who you want to assign the job to. Alternatively, current_user_email can be used.
                  default: 643197
                  format: int32
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      tags:
      - Capture Requests
  /api/v2/capture_requests/exists:
    get:
      summary: Check for Existing Capture Request
      description: ''
      operationId: check-for-existing-capture-request
      parameters:
      - name: email
        in: query
        description: Required. The email address of the user
        schema:
          type: integer
          format: int32
          default: null
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Capture Requests
  /api/v2/capture_requests/{capture_request_identifier}:
    get:
      summary: Get Capture Request Link
      description: ''
      operationId: get-capture-request-link
      parameters:
      - name: capture_request_identifier
        in: path
        description: The capture request identifier ID.
        schema:
          type: string
          default: xpod232
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Capture Requests
  /api/v2/capture_requests/{capture_request_id}:
    delete:
      summary: Delete Capture Request
      description: ''
      operationId: delete-capture-request
      parameters:
      - name: capture_request_id
        in: path
        description: The ID of the capture request you want to delete.
        schema:
          type: integer
          format: int32
          default: 8675309
        required: true
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Capture Requests
  /api/v2/capture_requests/{capture_request_id}/resend_notifications:
    post:
      summary: Resend Capture Request Notifications
      description: ''
      operationId: resend-capture-request-notifications
      parameters:
      - name: capture_request_id
        in: path
        description: The ID of the capture request to resend.
        schema:
          type: integer
          format: int32
          default: 8675309
        required: true
      deprecated: false
      tags:
      - Capture Requests
  /api/v2/capture_requests/{id}/details:
    get:
      description: ''
      responses:
        '200':
          description: ''
      parameters:
      - in: path
        name: id
        schema:
          type: string
        required: true
      - in: query
        name: id
        schema:
          type: string
        description: 'The ID of the capture request you are getting details for. '
        required: true
      operationId: get_api-v2-capture-requests-id-details
      tags:
      - Capture Requests
      summary: Get api v2 capture requests id details
      x-summary-source: derived
components:
  securitySchemes:
    sec0:
      type: oauth2
      flows: {}
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://developers.hover.to/reference
  harvested: '2026-10-14'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://developers.hover.to/reference/blueprint-upload-build-all.md
  - https://developers.hover.to/reference/blueprint-upload-specify-details.md
  - https://developers.hover.to/reference/check-for-existing-capture-request.md
  - https://developers.hover.to/reference/create-capture-request.md
  - https://developers.hover.to/reference/create-deliverable-change-request.md
  - https://developers.hover.to/reference/create-job-share-link-with-password.md
  - https://developers.hover.to/reference/create-note.md
  - https://developers.hover.to/reference/create-pdf-or-csv.md
  - https://developers.hover.to/reference/delete-capture-request.md
  - https://developers.hover.to/reference/delete-job-share-link.md
  - https://developers.hover.to/reference/delete-note.md
  - https://developers.hover.to/reference/delete-pending-change-order-request.md
  - https://developers.hover.to/reference/delete-webhook.md
  - https://developers.hover.to/reference/generate-access-token.md
  - https://developers.hover.to/reference/get-agreement-details-1.md
  - https://developers.hover.to/reference/get-authorization-code.md
  - https://developers.hover.to/reference/get-capture-request-link.md
  - https://developers.hover.to/reference/get-esx-export.md
  - https://developers.hover.to/reference/get-fml-export.md
  - https://developers.hover.to/reference/get-inspection-pdf-1.md
  - https://developers.hover.to/reference/get-inspection-workflow-details.md
  - https://developers.hover.to/reference/get-jobs-payment-details.md
  - https://developers.hover.to/reference/get-json-measurements.md
  - https://developers.hover.to/reference/get-measurements-pdf.md
  - https://developers.hover.to/reference/get-payment-receipt-html.md
  - https://developers.hover.to/reference/get-payment-receipt-pdf.md
  - https://developers.hover.to/reference/get-pdf-or-csv.md
  - https://developers.hover.to/reference/get-skp-export.md
  - https://developers.hover.to/reference/get-upgrade-price.md
  - https://developers.hover.to/reference/get-wireframe-images-1.md
  - https://developers.hover.to/reference/get-xlsx-measurements.md
  - https://developers.hover.to/reference/get-xml-3d-export.md
  - https://developers.hover.to/reference/invite-user.md
  - https://developers.hover.to/reference/list-available-deliverables.md
  - https://developers.hover.to/reference/list-capture-requests.md
  - https://developers.hover.to/reference/list-deliverable-change-requests.md
  - https://developers.hover.to/reference/list-estimates.md
  - https://developers.hover.to/reference/list-instant-design-images.md
  - https://developers.hover.to/reference/list-instant-design-leads.md
  - https://developers.hover.to/reference/list-job-share-links.md
  - https://developers.hover.to/reference/list-jobs.md
  - https://developers.hover.to/reference/list-notes.md
  - https://developers.hover.to/reference/list-organization-tree.md
  - https://developers.hover.to/reference/list-payments.md
  - https://developers.hover.to/reference/list-users.md
  - https://developers.hover.to/reference/list-wallets.md
  - https://developers.hover.to/reference/list-webhooks.md
  - https://developers.hover.to/reference/multi-structure-test-jobs.md
  - https://developers.hover.to/reference/re-assign-requesting-user.md
  - https://developers.hover.to/reference/refresh-access-token.md
  - https://developers.hover.to/reference/register-webhook.md
  - https://developers.hover.to/reference/remove-user-from-org.md
  - https://developers.hover.to/reference/resend-capture-request-notifications.md
  - https://developers.hover.to/reference/resend-webhook-verification-code.md
  - https://developers.hover.to/reference/send-invitation-email.md
  - https://developers.hover.to/reference/share-inspection-workflow.md
  - https://developers.hover.to/reference/show-capture-request-details.md
  - https://developers.hover.to/reference/show-estimate-details.md
  - https://developers.hover.to/reference/show-instant-design-image.md
  - https://developers.hover.to/reference/show-instant-design-lead.md
  - https://developers.hover.to/reference/show-job-details.md
  - https://developers.hover.to/reference/show-job-share-link.md
  - https://developers.hover.to/reference/show-organization-details.md
  - https://developers.hover.to/reference/show-user-profile.md
  - https://developers.hover.to/reference/update-a-job.md
  - https://developers.hover.to/reference/update-job-share-link.md
  - https://developers.hover.to/reference/update-job-test-state-single-structure.md
  - https://developers.hover.to/reference/update-note.md
  - https://developers.hover.to/reference/update-organization.md
  - https://developers.hover.to/reference/verify-webhook.md
  merge:
    pages: 70
    deduped: 69
    conflicts_kept_first: 0