# Hover Documentation > Documentation for Hover ## Guides - [Welcome to the Hover API](https://developers.hover.to/docs/welcome.md) - [Creating and Managing Integrations for Development](https://developers.hover.to/docs/creating-and-managing-integrations.md): Information for developers on how to begin building and managing Hover Integrations - [Authenticating with Hover's API](https://developers.hover.to/docs/oauth-20-authentication.md): How to use your API credentials to authenticate with Hover's API - [Authentication for MCP Use](https://developers.hover.to/docs/authentication-for-mcp-use.md): Keeping your access token up to date locally for MCP usage. - [Using Postman with Hover's API](https://developers.hover.to/docs/using-postman-with-hovers-api.md): This tutorial will walk you through setting up an environment with Postman to interact with Hover's API - [Rate Limits and Request Timeouts](https://developers.hover.to/docs/api-usage-and-limits.md) - [Submitting your integration to the Hover App Marketplace](https://developers.hover.to/docs/posting-your-integration-to-the-hover-marketplace.md) - [Marketplace Integration Information Details](https://developers.hover.to/docs/third-party-integration-requirements.md) - [Multi-Structure Workflow for Integrations](https://developers.hover.to/docs/multi-structure-workflow-for-integrations.md) - [Search & Sync Integration Workflow](https://developers.hover.to/docs/integration-search-sync-workflow.md): A common integration workflow for searching and syncing job & model details - [Processing Failed Jobs and Models](https://developers.hover.to/docs/retrieving-failure-reasons.md) - [Webhooks](https://developers.hover.to/docs/leveraging-hovers-webhooks.md) - [Hover Webhook Events](https://developers.hover.to/docs/hovers-available-webhooks.md) - [Testing your Integration](https://developers.hover.to/docs/testing-your-integration.md): Using the Hover Test Jobs endpoint to test your integration without physically capturing a property. - [Hover Capture Requests](https://developers.hover.to/docs/understanding-capture-requests.md) - [Capture Requests and the Hover API](https://developers.hover.to/docs/capture-requests-via-the-api.md) - [Retrieving Capture Request Links](https://developers.hover.to/docs/retrieving-capture-request-links.md) - [Job Deliverable Types](https://developers.hover.to/docs/understanding-deliverable-types.md) - [Organization Hierarchy and Wallets](https://developers.hover.to/docs/understanding-companies-orgs-and-wallets.md) - [Embedding Capture Request Forms from Hover](https://developers.hover.to/docs/embeddable-capture-request-forms-from-hover.md) - [Using Shared Wallets on API Created Jobs and Capture Requests](https://developers.hover.to/docs/using-shared-wallets-on-api-created-jobs-and-capture-requests.md) - [Images](https://developers.hover.to/docs/job-images.md): How to retrieve wireframe and rotated images for a Job. - [Rotated Images](https://developers.hover.to/docs/rotated-images.md) - [Estimates Integration Workflows](https://developers.hover.to/docs/estimates-integrations.md): How to use Hover's estimate API endpoints within your integration. - [Integrating with Zapier](https://developers.hover.to/docs/mental-model-of-zapier.md) - [Supported Triggers](https://developers.hover.to/docs/triggers.md) - [Job Updated](https://developers.hover.to/docs/zapier-job-updated.md) - [Supported Actions](https://developers.hover.to/docs/actions.md) - [Download Job Measurements as a File](https://developers.hover.to/docs/download-job-measurements-as-a-file.md): This action obtains the Measurements File for a given job - [Create a Capture Request Action](https://developers.hover.to/docs/send-capture-request-action.md) - [Obtaining Material List data using Zapier](https://developers.hover.to/docs/obtaining-material-list-data-using-zapier.md): This guide will walk you through setting up a Zapier trigger and action to obtain Material List data in Hover - [Obtaining Estimation, Proposal, and Order data using Zapier](https://developers.hover.to/docs/obtaining-estimation-proposal-and-order-data-using-zapier.md) - [Sending Hover Capture Requests (Connects) using Zapier](https://developers.hover.to/docs/sending-hover-connects-using-zapier.md): Build a form for your website and automatically send Hover Connect Requests to your prospective homeowners. - [Getting Leads from Zapier](https://developers.hover.to/docs/getting-leads-from-zapier.md) - [Integration Overview](https://developers.hover.to/docs/integration-overview.md) - [Installation Instructions](https://developers.hover.to/docs/hover-for-salesforce-installation-instructions.md) - [Estimate Integration Installation](https://developers.hover.to/docs/material-list-integration-installation.md): This is a supplementary guide for integrating Hover Estimate data into Salesforce - [Usage Instructions](https://developers.hover.to/docs/usage-instructions.md) - [Custom Settings](https://developers.hover.to/docs/custom-settings.md) - [Release Notes](https://developers.hover.to/docs/release-notes.md) - [What is Hover MCP?](https://developers.hover.to/docs/what-is-hover-mcp.md): What is an MPC, and why does Hover have one? - [Connecting Hover MCP](https://developers.hover.to/docs/mcp-2.md): How and why you would want to connect to Hover MCP - [Connecting to ChatGPT](https://developers.hover.to/docs/connected-to-chatgpt.md): This guide will walk you through how to connect Hover MCP to Chat GPT - [Connecting to Cursor](https://developers.hover.to/docs/connecting-to-cursor.md): This guide will walk you through how to connect Hover MCP to your Cursor IDE ## API Reference - [Authentication (OAuth 2.0)](https://developers.hover.to/reference/authentication-oauth-20.md) - [Get Authorization Code](https://developers.hover.to/reference/get-authorization-code.md): Use this endpoint to generate an Authentication code which will be used in the Access Token generation step - [Generate Access Token](https://developers.hover.to/reference/generate-access-token.md): Use this endpoint to generate an Access Token which is used to Authenticate to access Hover data. - [Refresh Access Token](https://developers.hover.to/reference/refresh-access-token.md): Use this endpoint to exchange your Refresh Token for a new Access Token, before Access Token expires. - [Testing Endpoints](https://developers.hover.to/reference/testing-endpoints.md): Using Hover's API endpoints to test your integration without phyiscally capturing a property - [Single Structure Test Jobs](https://developers.hover.to/reference/update-job-test-state-single-structure.md): This endpoint allows a mocked single-structure test job to be created for development testing; this endpoint does fire realistic webhooks. - [Multi-Structure Test Jobs](https://developers.hover.to/reference/multi-structure-test-jobs.md): This endpoint allows a mocked multi-structure test job to be created for development testing; this endpoint does not fire expected webhooks. - [Webhooks](https://developers.hover.to/reference/webhooks.md) - [List Webhooks](https://developers.hover.to/reference/list-webhooks.md): This endpoint lists all webhooks associated with the authenticated organization. - [Register Webhook](https://developers.hover.to/reference/register-webhook.md): This endpoint registers a webhook to be used within an integration. Registering a webhook must happen before verifying a webhook. - [Verify Webhook](https://developers.hover.to/reference/verify-webhook.md): This endpoint verifies a previously registered webhook, when given a verification code, and allows events to begin being sent. - [Delete Webhook](https://developers.hover.to/reference/delete-webhook.md): Use this endpoint to remove a webhook from the authenticated account, and stop having events sent to it. - [Resend Webhook Verification Code](https://developers.hover.to/reference/resend-webhook-verification-code.md): This endpoint will resend a verification code for a registered webhook. - [Capture Requests](https://developers.hover.to/reference/capture-requests.md) - [List Capture Requests](https://developers.hover.to/reference/list-capture-requests.md): Use this endpoint to list all capture requests for a your organization, given a user ID. - [Create a Capture Request](https://developers.hover.to/reference/create-capture-request.md): Use this endpoint to create a new Capture Request, which creates a shell Job and invites a user to capture the Job. - [Resend Capture Request Notifications](https://developers.hover.to/reference/resend-capture-request-notifications.md): Resend a Capture Request notification using this endpoint. - [Delete Capture Request](https://developers.hover.to/reference/delete-capture-request.md): Delete an existing Capture Request using this endpoint. - [Check for Existing Capture Request](https://developers.hover.to/reference/check-for-existing-capture-request.md): Check if there is an existing Capture Request for an email using this endpoint. - [Get Capture Request Link](https://developers.hover.to/reference/get-capture-request-link.md): Get the raw HTML page for a Capture Request using this endpoint. - [Show Capture Request Details](https://developers.hover.to/reference/show-capture-request-details.md): This endpoint takes in a numeric capture request ID and returns its details. - [Jobs](https://developers.hover.to/reference/jobs.md) - [List Jobs](https://developers.hover.to/reference/list-jobs.md) - [Show Job Details](https://developers.hover.to/reference/show-job-details.md): Use this endpoint to show all details of a Job given the job id. This endpoint returns almost all data needed on a job. Use this endpoint to get links to job measurements as json, xlsx, skp, xml, as well as job images. - [Create a Job](https://developers.hover.to/reference/createajob.md): ## Create A Job This endpoint creates a new job within your organization that is ready for image [capture within the mobile application](https://help.hover.to/en/articles/4278777-how-to-capture-photos-with-hover) (where a homeowner, field tech etc., could capture the photos.). It isn't necessary to create a Hover job via the API, although it may be useful depending on the needs of your integration. ### Why would I use this? Should I use the Job Creation endpoint? 🛑 Please note, we do not recommend using this [Create a Job endpoint](https://developers.hover.to/reference/createajob) in most cases. Job creation from this endpoint does not kick off any kind of webhook event denoting the job has been captured which is essential to most API integrations. In lieu of this endpoint we recommend using Capture requests, and the [Create Capture Requests](https://developers.hover.to/reference/createacapturerequest) endpoint which also creates Jobs, but with capture completed statuses; meaning you get webhook events for both Job states and Capture Request States. Learn more [here.](https://developers.hover.to/reference/capture-requests) 🛑 This end point might be used to create a Hover job after a request for a quote is submited by a homeowner. Below are some common data leveraged from this endpoint. - The ability to know the ID of a Hover job before it is uploaded - _When creating jobs directly from the mobile application, the Hover job identifier is created after upload._ - The ability to pre-fill information relating to a Hover capture - _When creating a job directly from the mobile application, the capturing user will be asked to provide metadata such as the address and customer name._ Creating a job is different than creating a capture request: Creating a job provides a shell job that is visible for a given user within the HOVER app, but it does not send a direct notification or invite. This is typically used for creating new jobs to be captured by HOVER users within your organization. Creating a capture request will create a job, but it will also send an invite to the capturing user. **🛑 Additional Params Needed for Org-Level Auth** **🛑** This endpoint, when used with Org-level OAuth 2.0, requires a `params[current_user_email]` or >`params[current_user_id]`. Otherwise, a 422 unprocessable entity may be returned as a response. ### Response Code Snippet See an example 201 response here, then follow below to learn more about the request and what makes up the responses. ``` json { "job": { "id": 9824755, "org_id": 600530, "name": "Bluth Development House 1", "org_name": "Developer Docs Org", "user_name": "geoff.hull+devdocs@hoverinc.com", "user_id": 1537006, "location_line_1": "123 HOVER Way", "location_line_2": "", "location_city": "Los Angeles", "location_region": "CA", "location_postal_code": "90210", "location_country": "US", "location_lat": null, "location_lon": null, "location": { "line_1": "123 HOVER Way", "line_2": "", "city": "Los Angeles", "region": "CA", "postal_code": "90210", "country": "US" }, "customer_first_name": null, "customer_name": "Michael Bluth", "customer_phone": "5558675309", "customer_notes": null, "customer_email": "homeowner@hover.to", "customer_contact_only_by_email": false, "customer_contact": null, "created_at": "2023-07-25T22:51:53.552Z", "updated_at": "2023-07-25T22:51:53.680Z", "archived": false, "state": "uploading", "example": false, "shared": false, "machete_features": [ "ShareFeature", "MeasurementsFeature", "DesignFeature" ], "contractor_estimate_sent_to": null, "hero_image": null, "via_job_share": null, "machete_blob": { "geometrySrc": "https://hover.to/api/v1/models/9822327/model_json_v3", "metadataSrc": "https://hover.to/api/v1/models/9822327/machete", "productsSrc": "https://products.hover.to/hover_models/products.json", "useInfoFeature": true, "InfoFeature": { "address": "123 HOVER Way", "username": "HOVER" }, "useOptInFeature": true, "OptInFeature": { "enabled": true, "designProUrl": "https://hover.to/3d/9824755" }, "useDesignPro": true, "DesignPro": { "usePBRMode": false }, "PlanetTerror": { "productsSrc": "https://products.hover.to/hover_models/products.json", "manufacturersSrc": "https://products.hover.to/hover_models/manufacturers.json?provider_ids[]=56&provider_ids[]=57&provider_ids[]=58&provider_ids[]=59&provider_ids[]=91&provider_ids[]=1&provider_ids[]=2&provider_ids[]=6&provider_ids[]=7&provider_ids[]=3&provider_ids[]=9&provider_ids[]=11&provider_ids[]=5&provider_ids[]=12&provider_ids[]=14&provider_ids[]=15&provider_ids[]=16&provider_ids[]=17&provider_ids[]=18&provider_ids[]=225&provider_ids[]=54&provider_ids[]=4&provider_ids[]=371&provider_ids[]=52&provider_ids[]=389&provider_ids[]=424&provider_ids[]=1745&provider_ids[]=1749&provider_ids[]=8&provider_ids[]=1756&provider_ids[]=1201&provider_ids[]=8485&provider_ids[]=5839&provider_ids[]=8532&provider_ids[]=8502", "manufacturerProductsSrc": "https://products.hover.to/hover_models/manufacturer_products.json" }, "useMeasurementsFeature": true, "MeasurementsFeature": { "labelsSrc": "https://hover.to/hover_models/labels.json", "measurementsSrc": "https://hover.to/api/v1/models/9822327/machete_model_measurements", "includeProMeasurements": true, "includePremiumMeasurements": true, "includeRoof": true, "includeWalls": true, "includeOpenings": true, "includeSurfaceAreas": true, "useMetricSystem": false }, "useShareFeature": true, "ShareFeature": {}, "useLabsFeature": false, "useDesignFeature": true, "DesignFeature": { "labelsSrc": "https://hover.to/hover_models/labels.json", "manufacturersSrc": "https://products.hover.to/hover_models/manufacturers.json?provider_ids[]=56&provider_ids[]=57&provider_ids[]=58&provider_ids[]=59&provider_ids[]=91&provider_ids[]=1&provider_ids[]=2&provider_ids[]=6&provider_ids[]=7&provider_ids[]=3&provider_ids[]=9&provider_ids[]=11&provider_ids[]=5&provider_ids[]=12&provider_ids[]=14&provider_ids[]=15&provider_ids[]=16&provider_ids[]=17&provider_ids[]=18&provider_ids[]=225&provider_ids[]=54&provider_ids[]=4&provider_ids[]=371&provider_ids[]=52&provider_ids[]=389&provider_ids[]=424&provider_ids[]=1745&provider_ids[]=1749&provider_ids[]=8&provider_ids[]=1756&provider_ids[]=1201&provider_ids[]=8485&provider_ids[]=5839&provider_ids[]=8532&provider_ids[]=8502", "productsSrc": "https://products.hover.to/hover_models/products.json", "manufacturerProductsSrc": "https://products.hover.to/hover_models/manufacturer_products.json", "showWindowColors": false } }, "deliverable_id": 3, "estimated_hours_to_completion": 0, "approved": true, "completed_at": null, "roof_estimate_access_level": "instant", "roof_estimate_supported": true, "roof_estimate_presold": false, "roof_estimate_purchase_state": null, "property_type": "single_family_residential", "client_identifier": "521b9a3b-759b-49ea-9b1e-7632aec3f45a", "suppress_email": null, "capture_session_identifier": null, "external_identifier": "54965", "complete_expedited": false, "blueprint": false, "symbility_xml_url": null, "additional_information": null, "external_identifier_label": "Lead Number", "wallet": { "id": 600442, "org": { "customer_display_name": "Developer Docs Org" } }, "additional_captured_jobs": [], "can_request_hi_def_rendering": true, "can_access_hi_def_rendering": true, "can_order_hi_def_rendering": true, "file_attachments": [], "models": [ { "id": 9822327, "job_id": 9824755, "address": null, "position_wgs": [], "model_json_v3": null, "atlas": null, "created_at": "2023-07-25T22:51:53.601Z", "updated_at": "2023-07-25T22:51:53.612Z", "archive_number": null, "archived_at": null, "state": "uploading", "original_model_id": null, "video": null, "machete": null, "siding_report": null, "payment_method": "free", "created_with_job": true, "image_archive": { "upload_url": "https://s3.amazonaws.com/files.production.hover.to/Hyperion/Model/9822327/image_archive.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATQULT2KNHFWYSSCT/20230725/us-east-1/s3/aws4_request&X-Amz-Date=20230725T225153Z&X-Amz-Expires=345600&X-Amz-SignedHeaders=host&X-Amz-Signature=0667873ea91eb56767bd2c1a95848f491cda8e59bd85c65235aa93d7b9c52ec5", "cloudfront_upload_url": "https://hover.to/Hyperion/Model/9822327/image_archive.zip?response-content-type=application/octet-stream&Expires=1690671113&Signature=CzuHdJWtG9OG2w1Tq1oa7NnQGsVy3MAJ4klSnjtnJ86cCvO55etKejEsuZm~Qdx9~zJihJUebIUA6C-517i-iwgivI8aZaBRbnhaRy1NjdlAIjeb7S6WjmaDMC-7rSgRhzYjDqOFgkGrq2~8QVK7BxHYY75WbhSWc9A-BX8XxyuvXzMy1pcNgiBaNFV63scWt5DRFMuV1bKrYKcVxwPKpkZpQSZpqsW588PGau1aAyLy-4pIi--5QImWAjUKbyKZiSoqultlUZeTBz4s2FDwpEIRlLSXr6Yq55ZBxoWHI87tkR5BGokXzyRjYiS9LyPwyhFTpIFYU~OyHVM2gv6foA__&Key-Pair-Id=APKAJOCSUB5UYQFW7A5Q", "high_res": { "upload_url": "https://s3.amazonaws.com/files.production.hover.to/Hyperion/Model/9822327/image_archive_high_res.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATQULT2KNHFWYSSCT/20230725/us-east-1/s3/aws4_request&X-Amz-Date=20230725T225153Z&X-Amz-Expires=345600&X-Amz-SignedHeaders=host&X-Amz-Signature=279ddcfc3625c53e623c2114f70fb0f598f82d67f8042f179640dc9c35e366bf", "cloudfront_upload_url": "https://hover.to/Hyperion/Model/9822327/image_archive_high_res.zip?response-content-type=application/octet-stream&Expires=1690671113&Signature=HO6B1CQrA30qCAwiU27nf-H7rX9Q4hNZhsE8H00-~o6PSh4SvCp5lKz87E74w2WzSomh8B8uzN0jKBOOKhROm6KGURS7E6SVycYaN58s7fm42hd2ogeSYPMUovNzoauzPzAG43iuBLMvpIX4MKxjSiLYl5M40OAHVvD3OfEXtJCdvYaiyPw97lOdAf2m7nBg2SDENXQ1CPPNxganQVvX8uu3lyxKy53gqnWvLGi~7mjUHj6qxT9hfnuCtd9hH8AZRKCjkho6SoYSqigX7e-1Su~IsScaHJ9m4VRXnKTRya-~l19Opfu4PMdFtv1L5TjyWZCiGje~GVDz~mZqVaCbrA__&Key-Pair-Id=APKAJOCSUB5UYQFW7A5Q" } }, "token": null, "machete_model_measurements": {}, "pro_measurements": null, "pro_premium_measurements": null, "roof_measurements": null, "complexity_attributes": null, "failure_reason": null, "manually_uploaded_by_id": null, "manowar_identifier": null, "message_to_production_team": null, "tracking_log": {}, "export": null, "reprocessed": false, "important_changed_areas_to_notify_user_about": null, "wireframe_front": {}, "wireframe_front_right": {}, "wireframe_right": {}, "wireframe_right_back": {}, "wireframe_back": {}, "wireframe_back_left": {}, "wireframe_left": {}, "wireframe_left_front": {}, "wireframe_footprint": {}, "wireframe_roof": {}, "total_living_area_measurements": null, "total_living_area_plus_measurements": null, "wireframe_total_living_area": {}, "cv_data": {}, "measurement_results_s3_key": null, "modeling_status": null, "dense_capture": null, "interior_floor_plan_measurements": null, "unstructured_mesh": {}, "structured_mesh": {}, "cameras": {}, "footprint_to_a": [], "archived": false, "complexity_score": "large", "is_3d_available": false, "polygon": null, "images": [] } ], "job_assignments": [ { "id": 14905200, "user_id": 1537006, "job_id": 9824755, "kind": "creator", "archived": false, "archived_at": null, "created_at": "2023-07-25T22:51:53.577Z", "updated_at": "2023-07-25T22:51:53.577Z", "user": { "id": 1537006, "first_name": "Geoff", "last_name": "Hull", "email": "geoff.hull+devdocs@hoverinc.com", "time_zone": "Pacific Time (US & Canada)", "aasm_state": "activated", "sign_in_count": 0, "preferred_identifier": null, "require_job_approval": false }, "assigned_by": null, "org": { "id": 600530, "parent_id": 492855, "kind": "dealer", "sort_order": null, "name": "Developer Docs Org", "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "model_price": 4995, "updated_at": "2023-07-25T20:28:07.766Z", "ordering_email": "", "customer_display_name": "Developer Docs Org" } } ], "org_job_accesses": [ { "id": 12565107, "lead_state": "assigned", "ordering_state": "lead", "kind": "creator", "job_id": 9824755, "archived": false, "via_job_share": null, "archived_at": null, "created_at": "2023-07-25T22:51:53.561Z", "org": { "id": 600530, "parent_id": 492855, "kind": "dealer", "sort_order": null, "name": "Developer Docs Org", "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "model_price": 4995, "updated_at": "2023-07-25T20:28:07.766Z", "ordering_email": "", "customer_display_name": "Developer Docs Org" }, "owner": { "id": 600530, "parent_id": 492855, "kind": "dealer", "sort_order": null, "name": "Developer Docs Org", "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "model_price": 4995, "updated_at": "2023-07-25T20:28:07.766Z", "ordering_email": "", "customer_display_name": "Developer Docs Org" } } ], "via_org_job_accesses": [ { "id": 12565107, "lead_state": "assigned", "ordering_state": "lead", "kind": "creator", "job_id": 9824755, "archived": false, "via_job_share": null, "archived_at": null, "created_at": "2023-07-25T22:51:53.561Z", "org": { "id": 600530, "parent_id": 492855, "kind": "dealer", "sort_order": null, "name": "Developer Docs Org", "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "model_price": 4995, "updated_at": "2023-07-25T20:28:07.766Z", "ordering_email": "", "customer_display_name": "Developer Docs Org" }, "owner": { "id": 600530, "parent_id": 492855, "kind": "dealer", "sort_order": null, "name": "Developer Docs Org", "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "model_price": 4995, "updated_at": "2023-07-25T20:28:07.766Z", "ordering_email": "", "customer_display_name": "Developer Docs Org" } } ], "orgs": [ { "id": 600530, "parent_id": 492855, "kind": "dealer", "sort_order": null, "name": "Developer Docs Org", "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "model_price": 4995, "updated_at": "2023-07-25T20:28:07.766Z", "ordering_email": "", "customer_display_name": "Developer Docs Org" } ], "job_shares": [], "through_org": { "id": 600530, "parent_id": 492855, "kind": "dealer", "sort_order": null, "name": "Developer Docs Org", "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "label_ids": [ 1, 2, 3, 4, 5, 6, 7, 100, 101, 102, 103, 104, 105, 200, 202, 203, 205, 206, 209, 210, 211, 220, 221, 222, 300, 301, 302, 303, 304, 305, 306, 307, 308, 309, 310, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 501, 502, 503, 504, 505, 506, 508, 509, 510, 511, 512, 513, 514, 515, 516, 517, 518, 519, 520, 521, 524, 525, 526, 527, 528, 529, 530, 531, 532, 533, 534, 601, 602, 603, 604 ], "cust_serv_contact": null, "cust_serv_name": null, "cust_serv_line_1": null, "cust_serv_line_2": null, "cust_serv_city": null, "cust_serv_region": null, "cust_serv_postal_code": null, "cust_serv_phone": null, "needs_3d": true, "supports_openings": false, "sales_rep": null, "updated_at": "2023-07-25T20:28:07.766Z", "manufacturer_ids": [ 56, 57, 58, 59, 91, 1, 2, 6, 7, 3, 9, 11, 5, 12, 14, 15, 16, 17, 18, 225, 54, 4, 371, 52, 389, 424, 1745, 1749, 8, 1756, 1201, 8485, 5839, 8532, 8502 ], "discounts": [ { "id": 5085, "partner_id": 1, "plan_id": 154, "job_percent": 0, "org_percent": 0, "name": "", "days_to_live": 0, "code": null, "subsidy": false, "trial": true, "minimum_condition": null, "maximum_condition": null, "hover_models_roof_estimate_percent": 0, "expires_at": null, "job_fixed_amount": 0, "org_fixed_amount": 0, "hover_models_roof_estimate_fixed_amount": 0, "upcharge_percent": 0, "upcharge_fixed_amount": 0, "internal_description": null, "usage_quota": 0, "hi_def_rendering_version_percent": 0, "hi_def_rendering_version_fixed_amount": 0, "blueprint_job_percent": 0, "blueprint_job_fixed_amount": 0 } ], "plan_billing_cycle": "monthly", "deliverable_id": null, "deliverable_ids": [ 2, 3, 7 ], "leaf": true, "empty": false, "created_at": "2023-07-25T20:20:50.240Z", "client_branding_logo_url": null, "test_data": false, "customer_display_name": "Developer Docs Org", "external_partner_identifier": "", "available_deliverable_ids": [ 2, 3, 7 ], "insurance": false, "managed": false, "own_wallet_is_billable": true, "brand": { "id": 65, "org_id": 39, "primary_color": { "b": 220, "g": 125, "r": 36 }, "secondary_color": { "b": 220, "g": 125, "r": 36 }, "tertiary_color": { "b": 220, "g": 125, "r": 36 }, "email_primary_color": { "b": 220, "g": 125, "r": 36 }, "email_secondary_color": { "b": 220, "g": 125, "r": 36 }, "email_tertiary_color": { "b": 220, "g": 125, "r": 36 }, "logo": { "url": "https://hover.to/api/v1/orgs/39/brand/logo.png", "thumb": { "url": "https://hover.to/api/v1/orgs/39/brand/logo.png?version=thumb" }, "nonretina": { "url": "https://hover.to/api/v1/orgs/39/brand/logo.png?version=nonretina" }, "retina": { "url": "https://hover.to/api/v1/orgs/39/brand/logo.png?version=retina" } }, "places_logo": { "url": "https://hover.to/api/v1/orgs/39/brand/places_logo.png" }, "email_logo": { "url": "https://hover.to/api/v1/orgs/39/brand/email_logo.png" }, "model_background_color": { "r": 8, "g": 148, "b": 213 }, "model_terrain_color": { "r": 102, "g": 153, "b": 102 } }, "settings": { "id": 600550, "org_id": 600530, "supports_openings_estimator": false, "needs_3d": true, "created_at": "2023-07-25T20:20:50.251Z", "updated_at": "2023-07-25T20:28:06.981Z", "auto_accept_users": true, "app_id": null, "machete_features": [ "measurements", "share", "design" ], "supports_openings_instant_estimator": false, "supports_redirect_to_new_website": true, "supports_full_job_info_display": true, "supports_machete": true, "model_price": 4995, "payment_method": "credit_card", "privacy_url": "/privacy", "terms_url": "/terms_of_use", "supports_co_branded_pro_measurements": false, "config": { "reconstruction": { "vip_org": false }, "hidden_attributes": { "Job": { "name": false } }, "job_priority_overrides": { "homeowner_connect": null, "expedite_roof_only": null, "interior_homeowner_connect": null } }, "priority": 12, "auto_invoice_enabled": null, "auto_invoice_day": null, "customer_account": null, "prepaid_quota": 0, "needs_texture": true, "supports_ordering": false, "supports_leads": false, "supports_wall_measurements": true, "supports_roof_measurements": true, "example_jobs_support": false, "example_jobs_selection_method": 0, "example_jobs_identifier": null, "app_name": null, "vip": false, "allow_waste_factor_preference": null, "invoiced": false, "hide_price_in_email": false, "only_design_pro_for_capture_request": false, "pre_select_capture_only_for_users": false, "exclude_capture_only": false, "interiors_priority": 12, "allow_homeowner_order_renderings": false, "show_design_studio": false, "locale": "en-US", "connect_message_template": null, "send_renderings_nudge_email": false, "commerce_product": "out_of_the_box_configuration", "exclude_from_bulk_enable_manufacturer": false, "allow_magic_link": false, "trial_enabled": true, "trial_start": "2023-07-25T20:20:50.392Z", "trial_period": 0, "trial_ends_at": null, "trial_remaining_jobs_allowed": null, "trial_expired": false, "auto_approve_roof_estimate": false, "capture_v2_enabled": true }, "preferences": { "id": 603634, "org_id": 600530, "created_at": "2023-07-25T20:20:50.257Z", "updated_at": "2023-07-25T20:28:06.958Z", "default_acl_template": "pro_plus", "ordering_email": "", "preferred_siding_waste_factor": null, "preferred_roofing_waste_factor": null, "external_identifier_label": "Lead Number", "external_identifier_required": false, "include_pro_user_name_in_invite_messages": true, "deliverable_id": null, "external_identifier_strict_validation": false }, "plan": { "id": 154, "name": "Pay As You Go", "partner_id": 1, "machete": true, "measurements": true, "measurements_branding": false, "ordering": false, "basic_export": true, "advanced_export": true, "basic_design": true, "advanced_design": true, "basic_team_management": false, "advanced_team_management": true, "created_at": "2017-04-18T18:01:06.462Z", "updated_at": "2023-05-05T19:53:47.483Z", "default": false, "visible": true, "sort_index": 1, "feature_icons": null, "feature_bullets": null, "email_receipt": true, "auto_assign_leads": false, "partner_analytics": false, "org_analytics": false, "allow_photo_only_capture": true, "homeowner_lead_capture": false, "plan_after_trial_id": null, "allows_instant_estimate": true, "allow_upgrade_to_pro": true, "allow_multi_family_residential_captures": false, "synced_monthly_with_stripe": true, "synced_yearly_with_stripe": true, "tier": "basic", "deleted": false, "deleted_at": null, "metadata": { "custom": false }, "stripe_product_identifier": "prod_JapZ0j1ZdCf3cz", "description": "No monthly fees, just order when you need it. No job discounts. Standard, but robust features include:\r\n\r\n- Measurement PDF\r\n- Interactive 3D model\r\n- Basic data export\r\n\r\n- Standard prices\r\n- Expedited jobs: +$40", "days_of_historical_job_access": 0, "partner": { "id": 1, "name": "Hover", "deliverable_ids": [ 2, 3, 7 ], "allow_deliverable_choice": true, "client_branding_logo_url": null, "allow_insurance_damage_capture": false, "allow_insurance_underwriting_capture": false, "identifier": "hover" } }, "wallet": { "id": 600442, "org_id": 600530, "stripe_token": null, "created_at": "2023-07-25T20:20:50.380Z", "updated_at": "2023-07-25T20:20:50.380Z", "stripe_customer_identifier": null, "billing_address_line_1": null, "billing_address_line_2": null, "billing_address_city": null, "billing_address_region": null, "billing_address_postal_code": null, "billing_address_country": null, "billing_email": null, "card_brand": null, "card_last4": null, "cardholder_name": null, "card_expires_on": null, "last_error": null, "deleted": false, "deleted_at": null, "balance": 0 }, "billable_wallets": [], "features": [ { "id": 12023, "accessor_id": 154, "accessor_type": "Plan", "enabled": true, "created_at": "2019-03-13T20:07:55.457Z", "updated_at": "2019-03-13T20:07:55.457Z", "identifier": "email_send_receipt", "deleted": false, "deleted_at": null }, { "id": 12024, "accessor_id": 154, "accessor_type": "Plan", "enabled": true, "created_at": "2019-03-13T20:07:55.482Z", "updated_at": "2019-03-13T20:07:55.482Z", "identifier": "hover_now", "deleted": false, "deleted_at": null }, { "id": 12025, "accessor_id": 154, "accessor_type": "Plan", "enabled": true, "created_at": "2019-03-13T20:07:55.495Z", "updated_at": "2019-03-13T20:07:55.495Z", "identifier": "prospect", "deleted": false, "deleted_at": null }, { "id": 12026, "accessor_id": 154, "accessor_type": "Plan", "enabled": true, "created_at": "2019-03-13T20:07:55.506Z", "updated_at": "2019-03-13T20:07:55.506Z", "identifier": "design_view_measurements_tool", "deleted": false, "deleted_at": null }, { "id": 12665, "accessor_id": 154, "accessor_type": "Plan", "enabled": true, "created_at": "2019-03-13T21:55:15.435Z", "updated_at": "2019-03-13T21:55:15.435Z", "identifier": "upgrade_to_pro", "deleted": false, "deleted_at": null }, { "id": 13849, "accessor_id": 154, "accessor_type": "Plan", "enabled": true, "created_at": "2019-05-01T20:02:51.717Z", "updated_at": "2019-05-01T20:02:51.717Z", "identifier": "team_management_advanced", "deleted": false, "deleted_at": null }, { "id": 51579, "accessor_id": 154, "accessor_type": "Plan", "enabled": true, "created_at": "2022-09-16T20:32:45.574Z", "updated_at": "2022-09-16T20:32:45.574Z", "identifier": "blueprints", "deleted": false, "deleted_at": null }, { "id": 113973, "accessor_id": 154, "accessor_type": "Plan", "enabled": true, "created_at": "2023-05-05T19:53:47.494Z", "updated_at": "2023-05-05T19:53:47.494Z", "identifier": "hi_def_rendering", "deleted": false, "deleted_at": null }, { "id": 120638, "accessor_id": 600530, "accessor_type": "Org", "enabled": true, "created_at": "2023-07-25T20:28:06.901Z", "updated_at": "2023-07-25T20:28:06.901Z", "identifier": "export_advanced_job", "deleted": false, "deleted_at": null }, { "id": 120639, "accessor_id": 600530, "accessor_type": "Org", "enabled": true, "created_at": "2023-07-25T20:28:06.905Z", "updated_at": "2023-07-25T20:28:06.905Z", "identifier": "measurements_files_access", "deleted": false, "deleted_at": null }, { "id": 120640, "accessor_id": 600530, "accessor_type": "Org", "enabled": true, "created_at": "2023-07-25T20:28:06.908Z", "updated_at": "2023-07-25T20:28:06.908Z", "identifier": "integrations", "deleted": false, "deleted_at": null }, { "id": 120641, "accessor_id": 600530, "accessor_type": "Org", "enabled": true, "created_at": "2023-07-25T20:28:06.911Z", "updated_at": "2023-07-25T20:28:06.911Z", "identifier": "ehi_project_management_product", "deleted": false, "deleted_at": null }, { "id": 120642, "accessor_id": 600530, "accessor_type": "Org", "enabled": true, "created_at": "2023-07-25T20:28:06.915Z", "updated_at": "2023-07-25T20:28:06.915Z", "identifier": "export_esx", "deleted": false, "deleted_at": null }, { "id": 120643, "accessor_id": 600530, "accessor_type": "Org", "enabled": true, "created_at": "2023-07-25T20:28:06.918Z", "updated_at": "2023-07-25T20:28:06.918Z", "identifier": "sequential_capture", "deleted": false, "deleted_at": null }, { "id": 120644, "accessor_id": 600530, "accessor_type": "Org", "enabled": true, "created_at": "2023-07-25T20:28:06.921Z", "updated_at": "2023-07-25T20:28:06.921Z", "identifier": "out_of_the_box_material_lists", "deleted": false, "deleted_at": null }, { "id": 120645, "accessor_id": 600530, "accessor_type": "Org", "enabled": true, "created_at": "2023-07-25T20:28:06.924Z", "updated_at": "2023-07-25T20:28:06.924Z", "identifier": "blueprints_commercial", "deleted": false, "deleted_at": null }, { "id": 120646, "accessor_id": 600530, "accessor_type": "Org", "enabled": true, "created_at": "2023-07-25T20:28:06.927Z", "updated_at": "2023-07-25T20:28:06.927Z", "identifier": "blueprints_interior_job_type", "deleted": false, "deleted_at": null }, { "id": 120647, "accessor_id": 600530, "accessor_type": "Org", "enabled": true, "created_at": "2023-07-25T20:28:06.929Z", "updated_at": "2023-07-25T20:28:06.929Z", "identifier": "inspection_checklist", "deleted": false, "deleted_at": null } ] }, "pending_capture_request": null, "capture_request": null, "roof_estimate": null } } ``` - [Archive Job Access](https://developers.hover.to/reference/archivejobaccess.md): ### What is this? This endpoint archives the job access. After archiving, this job will no longer show up on user's property list. You can still access archived job data on the `List Jobs` endpoint by setting the `archived` query parameter to `true`. ### Why would I use this? You might use this end point to archive a property that a homeowner never completed after a certain amount of time. You can also unarchive a job if the homeowner reaches out in the future. - [Update a Job](https://developers.hover.to/reference/update-a-job.md): Use this endpoint to update the details of a Job’s property or owner. - [Re-Assign Requesting User](https://developers.hover.to/reference/re-assign-requesting-user.md): Use this endpoint to re-assign the requesting user of a Job to a different user. - [Measurements and Exports](https://developers.hover.to/reference/measurements-and-deliverables.md) - [Get Measurements PDF](https://developers.hover.to/reference/get-measurements-pdf.md) - [Get JSON Measurements](https://developers.hover.to/reference/get-json-measurements.md) - [Get XML 3D Export](https://developers.hover.to/reference/get-xml-3d-export.md) - [GET XLSX Measurements](https://developers.hover.to/reference/get-xlsx-measurements.md) - [Get SKP Export](https://developers.hover.to/reference/get-skp-export.md) - [Get ESX Export](https://developers.hover.to/reference/get-esx-export.md) - [Get FML Export](https://developers.hover.to/reference/get-fml-export.md) - [Instant Design Images](https://developers.hover.to/reference/instant-design.md) - [List Instant Design Images](https://developers.hover.to/reference/list-instant-design-images.md): Use this endpoint to return a list of instant design images. - [Show Instant Design Image](https://developers.hover.to/reference/show-instant-design-image.md): Use this endpoint to returns the Instant Design image of the input image ID. - [Instant Design Leads](https://developers.hover.to/reference/instant-design-leads.md) - [List Instant Design Leads](https://developers.hover.to/reference/list-instant-design-leads.md): Use this endpoint to list all lead information submitted through the Instant Design lead form associated with the authenticated organization. - [Show Instant Design Lead Details](https://developers.hover.to/reference/show-instant-design-lead.md): Use this endpoint to retrieve detailed information for a single Instant Design lead given the lead ID - [Inspections](https://developers.hover.to/reference/inspections.md) - [List Inspections](https://developers.hover.to/reference/listinspections.md): Use this endpoint to return Inspections for a given Job. - [Get Inspection Details](https://developers.hover.to/reference/getinspectiondetails.md): Use this endpoint to return detailed Inspection information such as questions, answers, photos, and tags for a given inspection ID. - [Get Inspection Photos](https://developers.hover.to/reference/getinspectionphotos.md): Get Inspection Photos - [Get Inspection Workflow Details](https://developers.hover.to/reference/get-inspection-workflow-details.md): Use this endpoint to return specific Inspection workflow details when passing in an inspection workflow ID. - [Share Inspection Workflow](https://developers.hover.to/reference/share-inspection-workflow.md): Use this endpoint to share an Inspection Workflow with an organization. - [Get Inspection PDF](https://developers.hover.to/reference/get-inspection-pdf-1.md): Use this endpoint to retrieve an Inspection’s data in PDF format. - [List Organization Tree](https://developers.hover.to/reference/list-organization-tree.md): Use this endpoint to return the current authenticated Organization and children. - [Show Organization Details](https://developers.hover.to/reference/show-organization-details.md) - [Update Organization](https://developers.hover.to/reference/update-organization.md): Use this endpoint to update data associated with the authenticated organization. - [Images](https://developers.hover.to/reference/images.md) - [Get Wireframe Images](https://developers.hover.to/reference/get-wireframe-images-1.md): Endpoint for retrieving wireframe images for a specific model. Versions include url, compass, and top. - [Deliverable Change Requests](https://developers.hover.to/reference/deliverable-change-requests.md) - [List Deliverable Change Requests](https://developers.hover.to/reference/list-deliverable-change-requests.md): Retrieve a list of all deliverable changes requests for a specific Model. - [Get Upgrade Price](https://developers.hover.to/reference/get-upgrade-price.md): Retrieve pricing information for upgrading an existing deliverable for a model. - [Create Deliverable Change Request](https://developers.hover.to/reference/create-deliverable-change-request.md): Create a request to upgrade and pay for a Model to have an upgraded deliverable. - [Delete Pending Change Order Request](https://developers.hover.to/reference/delete-pending-change-order-request.md): Endpoint to delete a pending deliverable change request. - [List Users](https://developers.hover.to/reference/list-users.md): Use this endpoint to retrieve a list of all users within the authenticated organization. - [Show User Profile](https://developers.hover.to/reference/show-user-profile.md) - [Invite User](https://developers.hover.to/reference/invite-user.md): Use this endpoint to programmatically invite a user to your Hover organization. - [Remove User From Org](https://developers.hover.to/reference/remove-user-from-org.md): Use this endpoint to remove a user from your Hover organization. - [Send Invitation Email](https://developers.hover.to/reference/send-invitation-email.md): Use this endpoint to send an email invitation to a designated user after inviting them. - [List Job Share Links](https://developers.hover.to/reference/list-job-share-links.md): Use this endpoint to list all Job Shares across all jobs that the input user has access to. - [Show Job Share Link](https://developers.hover.to/reference/show-job-share-link.md): Use this endpoint to return the information and links for an input Job Share ID. - [Update Job Share Link](https://developers.hover.to/reference/update-job-share-link.md): Use this endpoint to update a Job Share link. - [Delete Job Share Link](https://developers.hover.to/reference/delete-job-share-link.md): Use this endpoint to delete a specific Job Share link. - [Create Job Share Link with Password](https://developers.hover.to/reference/create-job-share-link-with-password.md): Use this endpoint to create a shareable link for a Virtual Walkthrough on a job that can be password protected. - [List Notes](https://developers.hover.to/reference/list-notes.md): List all notes associated with a Job. - [Create Note](https://developers.hover.to/reference/create-note.md): Use this endpoint to create a note for a given Job ID in Hover. - [Update Note](https://developers.hover.to/reference/update-note.md): Use this endpoint to update a note on a Job in Hover. - [Delete Note](https://developers.hover.to/reference/delete-note.md) - [Wallets](https://developers.hover.to/reference/wallets.md) - [List Wallets](https://developers.hover.to/reference/list-wallets.md): Use this endpoint to retrieve a list of all wallets accessible to the current authenticated Hover organization. - [List Available Deliverables](https://developers.hover.to/reference/list-available-deliverables.md): Use this endpoint to retrieve a list of available deliverables for an input Wallet ID. - [List Payments](https://developers.hover.to/reference/list-payments.md): Use this endpoint to retrieve a list of payment data for all Jobs. - [Get Payment Receipt (HTML)](https://developers.hover.to/reference/get-payment-receipt-html.md): Use this endpoint to retrieve an HTML version of an invoice for a given payment ID. - [Get Payment Receipt (PDF)](https://developers.hover.to/reference/get-payment-receipt-pdf.md): Use this endpoint to retrieve a PDF version of an invoice for a given payment ID. - [Get Job's Payment Details](https://developers.hover.to/reference/get-jobs-payment-details.md): Use this endpoint to retrieve payment details for a given good type and good ID. - [Blueprint Jobs](https://developers.hover.to/reference/blueprint-jobs.md) - [Blueprint Upload - Build All](https://developers.hover.to/reference/blueprint-upload-build-all.md): Use this endpoint to upload a blueprint and reconstruct all elevations on the blueprint as their own Jobs. - [Blueprint Upload - Specify Details](https://developers.hover.to/reference/blueprint-upload-specify-details.md): Use this endpoint to upload a blueprint and specify which elevations to reconstruct as their own Jobs. - [Recommended Waste Factor](https://developers.hover.to/reference/recommended-waste-factor.md) - [Get Roof RWF](https://developers.hover.to/reference/get-roof-rwf.md): This endpoint uses Hover’s algorithm recommendation to return a roof waste percentage for input measurements. - [Estimates](https://developers.hover.to/reference/estimates.md): Getting estimates and estimation data - [List Estimates ](https://developers.hover.to/reference/list-estimates.md): List Estimates on a Job by Job ID - [Show Estimate Details](https://developers.hover.to/reference/show-estimate-details.md): Get the details of a specific estimate given its ID. - [Create a Deep Link](https://developers.hover.to/reference/create-a-deep-link.md): Use this reference to learn how to create a Hover deep link.