--- updatedAt: 2026-02-04T09:26:55.000Z agentTools: projectIndex: https://developers.hover.to/llms.txt --- # Create a Job ## 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 } } ``` # OpenAPI definition ````json { "openapi": "3.0.3", "info": { "title": "HOVER REST API", "version": "1.0.0", "contact": {} }, "servers": [ { "url": "https://hover.to" }, { "url": "https://sandbox.hover.to" }, { "url": "https://ehi.hover.to" } ], "paths": { "/api/v1/jobs": { "post": { "tags": [ "Jobs" ], "summary": "Create a Job", "description": "## Create A Job\n\nThis 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.\n\n### Why would I use this?\n\nShould I use the Job Creation endpoint?\n\nšŸ›‘ 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) šŸ›‘\n\nThis 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.\n\n- The ability to know the ID of a Hover job before it is uploaded\n \n - _When creating jobs directly from the mobile application, the Hover job identifier is created after upload._\n \n- The ability to pre-fill information relating to a Hover capture\n \n - _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._\n \n\nCreating a job is different than creating a capture request:\n\nCreating 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.\n\nCreating a capture request will create a job, but it will also send an invite to the capturing user.\n\n**šŸ›‘ Additional Params Needed for Org-Level Auth** **šŸ›‘**\n\nThis 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.\n\n### Response Code Snippet\n\nSee an example 201 response here, then follow below to learn more about the request and what makes up the responses.\n\n``` json\n{\n \"job\": {\n \"id\": 9824755,\n \"org_id\": 600530,\n \"name\": \"Bluth Development House 1\",\n \"org_name\": \"Developer Docs Org\",\n \"user_name\": \"geoff.hull+devdocs@hoverinc.com\",\n \"user_id\": 1537006,\n \"location_line_1\": \"123 HOVER Way\",\n \"location_line_2\": \"\",\n \"location_city\": \"Los Angeles\",\n \"location_region\": \"CA\",\n \"location_postal_code\": \"90210\",\n \"location_country\": \"US\",\n \"location_lat\": null,\n \"location_lon\": null,\n \"location\": {\n \"line_1\": \"123 HOVER Way\",\n \"line_2\": \"\",\n \"city\": \"Los Angeles\",\n \"region\": \"CA\",\n \"postal_code\": \"90210\",\n \"country\": \"US\"\n },\n \"customer_first_name\": null,\n \"customer_name\": \"Michael Bluth\",\n \"customer_phone\": \"5558675309\",\n \"customer_notes\": null,\n \"customer_email\": \"homeowner@hover.to\",\n \"customer_contact_only_by_email\": false,\n \"customer_contact\": null,\n \"created_at\": \"2023-07-25T22:51:53.552Z\",\n \"updated_at\": \"2023-07-25T22:51:53.680Z\",\n \"archived\": false,\n \"state\": \"uploading\",\n \"example\": false,\n \"shared\": false,\n \"machete_features\": [\n \"ShareFeature\",\n \"MeasurementsFeature\",\n \"DesignFeature\"\n ],\n \"contractor_estimate_sent_to\": null,\n \"hero_image\": null,\n \"via_job_share\": null,\n \"machete_blob\": {\n \"geometrySrc\": \"https://hover.to/api/v1/models/9822327/model_json_v3\",\n \"metadataSrc\": \"https://hover.to/api/v1/models/9822327/machete\",\n \"productsSrc\": \"https://products.hover.to/hover_models/products.json\",\n \"useInfoFeature\": true,\n \"InfoFeature\": {\n \"address\": \"123 HOVER Way\",\n \"username\": \"HOVER\"\n },\n \"useOptInFeature\": true,\n \"OptInFeature\": {\n \"enabled\": true,\n \"designProUrl\": \"https://hover.to/3d/9824755\"\n },\n \"useDesignPro\": true,\n \"DesignPro\": {\n \"usePBRMode\": false\n },\n \"PlanetTerror\": {\n \"productsSrc\": \"https://products.hover.to/hover_models/products.json\",\n \"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\",\n \"manufacturerProductsSrc\": \"https://products.hover.to/hover_models/manufacturer_products.json\"\n },\n \"useMeasurementsFeature\": true,\n \"MeasurementsFeature\": {\n \"labelsSrc\": \"https://hover.to/hover_models/labels.json\",\n \"measurementsSrc\": \"https://hover.to/api/v1/models/9822327/machete_model_measurements\",\n \"includeProMeasurements\": true,\n \"includePremiumMeasurements\": true,\n \"includeRoof\": true,\n \"includeWalls\": true,\n \"includeOpenings\": true,\n \"includeSurfaceAreas\": true,\n \"useMetricSystem\": false\n },\n \"useShareFeature\": true,\n \"ShareFeature\": {},\n \"useLabsFeature\": false,\n \"useDesignFeature\": true,\n \"DesignFeature\": {\n \"labelsSrc\": \"https://hover.to/hover_models/labels.json\",\n \"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\",\n \"productsSrc\": \"https://products.hover.to/hover_models/products.json\",\n \"manufacturerProductsSrc\": \"https://products.hover.to/hover_models/manufacturer_products.json\",\n \"showWindowColors\": false\n }\n },\n \"deliverable_id\": 3,\n \"estimated_hours_to_completion\": 0,\n \"approved\": true,\n \"completed_at\": null,\n \"roof_estimate_access_level\": \"instant\",\n \"roof_estimate_supported\": true,\n \"roof_estimate_presold\": false,\n \"roof_estimate_purchase_state\": null,\n \"property_type\": \"single_family_residential\",\n \"client_identifier\": \"521b9a3b-759b-49ea-9b1e-7632aec3f45a\",\n \"suppress_email\": null,\n \"capture_session_identifier\": null,\n \"external_identifier\": \"54965\",\n \"complete_expedited\": false,\n \"blueprint\": false,\n \"symbility_xml_url\": null,\n \"additional_information\": null,\n \"external_identifier_label\": \"Lead Number\",\n \"wallet\": {\n \"id\": 600442,\n \"org\": {\n \"customer_display_name\": \"Developer Docs Org\"\n }\n },\n \"additional_captured_jobs\": [],\n \"can_request_hi_def_rendering\": true,\n \"can_access_hi_def_rendering\": true,\n \"can_order_hi_def_rendering\": true,\n \"file_attachments\": [],\n \"models\": [\n {\n \"id\": 9822327,\n \"job_id\": 9824755,\n \"address\": null,\n \"position_wgs\": [],\n \"model_json_v3\": null,\n \"atlas\": null,\n \"created_at\": \"2023-07-25T22:51:53.601Z\",\n \"updated_at\": \"2023-07-25T22:51:53.612Z\",\n \"archive_number\": null,\n \"archived_at\": null,\n \"state\": \"uploading\",\n \"original_model_id\": null,\n \"video\": null,\n \"machete\": null,\n \"siding_report\": null,\n \"payment_method\": \"free\",\n \"created_with_job\": true,\n \"image_archive\": {\n \"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\",\n \"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\",\n \"high_res\": {\n \"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\",\n \"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\"\n }\n },\n \"token\": null,\n \"machete_model_measurements\": {},\n \"pro_measurements\": null,\n \"pro_premium_measurements\": null,\n \"roof_measurements\": null,\n \"complexity_attributes\": null,\n \"failure_reason\": null,\n \"manually_uploaded_by_id\": null,\n \"manowar_identifier\": null,\n \"message_to_production_team\": null,\n \"tracking_log\": {},\n \"export\": null,\n \"reprocessed\": false,\n \"important_changed_areas_to_notify_user_about\": null,\n \"wireframe_front\": {},\n \"wireframe_front_right\": {},\n \"wireframe_right\": {},\n \"wireframe_right_back\": {},\n \"wireframe_back\": {},\n \"wireframe_back_left\": {},\n \"wireframe_left\": {},\n \"wireframe_left_front\": {},\n \"wireframe_footprint\": {},\n \"wireframe_roof\": {},\n \"total_living_area_measurements\": null,\n \"total_living_area_plus_measurements\": null,\n \"wireframe_total_living_area\": {},\n \"cv_data\": {},\n \"measurement_results_s3_key\": null,\n \"modeling_status\": null,\n \"dense_capture\": null,\n \"interior_floor_plan_measurements\": null,\n \"unstructured_mesh\": {},\n \"structured_mesh\": {},\n \"cameras\": {},\n \"footprint_to_a\": [],\n \"archived\": false,\n \"complexity_score\": \"large\",\n \"is_3d_available\": false,\n \"polygon\": null,\n \"images\": []\n }\n ],\n \"job_assignments\": [\n {\n \"id\": 14905200,\n \"user_id\": 1537006,\n \"job_id\": 9824755,\n \"kind\": \"creator\",\n \"archived\": false,\n \"archived_at\": null,\n \"created_at\": \"2023-07-25T22:51:53.577Z\",\n \"updated_at\": \"2023-07-25T22:51:53.577Z\",\n \"user\": {\n \"id\": 1537006,\n \"first_name\": \"Geoff\",\n \"last_name\": \"Hull\",\n \"email\": \"geoff.hull+devdocs@hoverinc.com\",\n \"time_zone\": \"Pacific Time (US & Canada)\",\n \"aasm_state\": \"activated\",\n \"sign_in_count\": 0,\n \"preferred_identifier\": null,\n \"require_job_approval\": false\n },\n \"assigned_by\": null,\n \"org\": {\n \"id\": 600530,\n \"parent_id\": 492855,\n \"kind\": \"dealer\",\n \"sort_order\": null,\n \"name\": \"Developer Docs Org\",\n \"ancestral_name\": \"HOVER > Pro > Salesforce Package Development > Developer Docs Org\",\n \"model_price\": 4995,\n \"updated_at\": \"2023-07-25T20:28:07.766Z\",\n \"ordering_email\": \"\",\n \"customer_display_name\": \"Developer Docs Org\"\n }\n }\n ],\n \"org_job_accesses\": [\n {\n \"id\": 12565107,\n \"lead_state\": \"assigned\",\n \"ordering_state\": \"lead\",\n \"kind\": \"creator\",\n \"job_id\": 9824755,\n \"archived\": false,\n \"via_job_share\": null,\n \"archived_at\": null,\n \"created_at\": \"2023-07-25T22:51:53.561Z\",\n \"org\": {\n \"id\": 600530,\n \"parent_id\": 492855,\n \"kind\": \"dealer\",\n \"sort_order\": null,\n \"name\": \"Developer Docs Org\",\n \"ancestral_name\": \"HOVER > Pro > Salesforce Package Development > Developer Docs Org\",\n \"model_price\": 4995,\n \"updated_at\": \"2023-07-25T20:28:07.766Z\",\n \"ordering_email\": \"\",\n \"customer_display_name\": \"Developer Docs Org\"\n },\n \"owner\": {\n \"id\": 600530,\n \"parent_id\": 492855,\n \"kind\": \"dealer\",\n \"sort_order\": null,\n \"name\": \"Developer Docs Org\",\n \"ancestral_name\": \"HOVER > Pro > Salesforce Package Development > Developer Docs Org\",\n \"model_price\": 4995,\n \"updated_at\": \"2023-07-25T20:28:07.766Z\",\n \"ordering_email\": \"\",\n \"customer_display_name\": \"Developer Docs Org\"\n }\n }\n ],\n \"via_org_job_accesses\": [\n {\n \"id\": 12565107,\n \"lead_state\": \"assigned\",\n \"ordering_state\": \"lead\",\n \"kind\": \"creator\",\n \"job_id\": 9824755,\n \"archived\": false,\n \"via_job_share\": null,\n \"archived_at\": null,\n \"created_at\": \"2023-07-25T22:51:53.561Z\",\n \"org\": {\n \"id\": 600530,\n \"parent_id\": 492855,\n \"kind\": \"dealer\",\n \"sort_order\": null,\n \"name\": \"Developer Docs Org\",\n \"ancestral_name\": \"HOVER > Pro > Salesforce Package Development > Developer Docs Org\",\n \"model_price\": 4995,\n \"updated_at\": \"2023-07-25T20:28:07.766Z\",\n \"ordering_email\": \"\",\n \"customer_display_name\": \"Developer Docs Org\"\n },\n \"owner\": {\n \"id\": 600530,\n \"parent_id\": 492855,\n \"kind\": \"dealer\",\n \"sort_order\": null,\n \"name\": \"Developer Docs Org\",\n \"ancestral_name\": \"HOVER > Pro > Salesforce Package Development > Developer Docs Org\",\n \"model_price\": 4995,\n \"updated_at\": \"2023-07-25T20:28:07.766Z\",\n \"ordering_email\": \"\",\n \"customer_display_name\": \"Developer Docs Org\"\n }\n }\n ],\n \"orgs\": [\n {\n \"id\": 600530,\n \"parent_id\": 492855,\n \"kind\": \"dealer\",\n \"sort_order\": null,\n \"name\": \"Developer Docs Org\",\n \"ancestral_name\": \"HOVER > Pro > Salesforce Package Development > Developer Docs Org\",\n \"model_price\": 4995,\n \"updated_at\": \"2023-07-25T20:28:07.766Z\",\n \"ordering_email\": \"\",\n \"customer_display_name\": \"Developer Docs Org\"\n }\n ],\n \"job_shares\": [],\n \"through_org\": {\n \"id\": 600530,\n \"parent_id\": 492855,\n \"kind\": \"dealer\",\n \"sort_order\": null,\n \"name\": \"Developer Docs Org\",\n \"ancestral_name\": \"HOVER > Pro > Salesforce Package Development > Developer Docs Org\",\n \"label_ids\": [\n 1,\n 2,\n 3,\n 4,\n 5,\n 6,\n 7,\n 100,\n 101,\n 102,\n 103,\n 104,\n 105,\n 200,\n 202,\n 203,\n 205,\n 206,\n 209,\n 210,\n 211,\n 220,\n 221,\n 222,\n 300,\n 301,\n 302,\n 303,\n 304,\n 305,\n 306,\n 307,\n 308,\n 309,\n 310,\n 400,\n 401,\n 402,\n 403,\n 404,\n 405,\n 406,\n 407,\n 408,\n 409,\n 501,\n 502,\n 503,\n 504,\n 505,\n 506,\n 508,\n 509,\n 510,\n 511,\n 512,\n 513,\n 514,\n 515,\n 516,\n 517,\n 518,\n 519,\n 520,\n 521,\n 524,\n 525,\n 526,\n 527,\n 528,\n 529,\n 530,\n 531,\n 532,\n 533,\n 534,\n 601,\n 602,\n 603,\n 604\n ],\n \"cust_serv_contact\": null,\n \"cust_serv_name\": null,\n \"cust_serv_line_1\": null,\n \"cust_serv_line_2\": null,\n \"cust_serv_city\": null,\n \"cust_serv_region\": null,\n \"cust_serv_postal_code\": null,\n \"cust_serv_phone\": null,\n \"needs_3d\": true,\n \"supports_openings\": false,\n \"sales_rep\": null,\n \"updated_at\": \"2023-07-25T20:28:07.766Z\",\n \"manufacturer_ids\": [\n 56,\n 57,\n 58,\n 59,\n 91,\n 1,\n 2,\n 6,\n 7,\n 3,\n 9,\n 11,\n 5,\n 12,\n 14,\n 15,\n 16,\n 17,\n 18,\n 225,\n 54,\n 4,\n 371,\n 52,\n 389,\n 424,\n 1745,\n 1749,\n 8,\n 1756,\n 1201,\n 8485,\n 5839,\n 8532,\n 8502\n ],\n \"discounts\": [\n {\n \"id\": 5085,\n \"partner_id\": 1,\n \"plan_id\": 154,\n \"job_percent\": 0,\n \"org_percent\": 0,\n \"name\": \"\",\n \"days_to_live\": 0,\n \"code\": null,\n \"subsidy\": false,\n \"trial\": true,\n \"minimum_condition\": null,\n \"maximum_condition\": null,\n \"hover_models_roof_estimate_percent\": 0,\n \"expires_at\": null,\n \"job_fixed_amount\": 0,\n \"org_fixed_amount\": 0,\n \"hover_models_roof_estimate_fixed_amount\": 0,\n \"upcharge_percent\": 0,\n \"upcharge_fixed_amount\": 0,\n \"internal_description\": null,\n \"usage_quota\": 0,\n \"hi_def_rendering_version_percent\": 0,\n \"hi_def_rendering_version_fixed_amount\": 0,\n \"blueprint_job_percent\": 0,\n \"blueprint_job_fixed_amount\": 0\n }\n ],\n \"plan_billing_cycle\": \"monthly\",\n \"deliverable_id\": null,\n \"deliverable_ids\": [\n 2,\n 3,\n 7\n ],\n \"leaf\": true,\n \"empty\": false,\n \"created_at\": \"2023-07-25T20:20:50.240Z\",\n \"client_branding_logo_url\": null,\n \"test_data\": false,\n \"customer_display_name\": \"Developer Docs Org\",\n \"external_partner_identifier\": \"\",\n \"available_deliverable_ids\": [\n 2,\n 3,\n 7\n ],\n \"insurance\": false,\n \"managed\": false,\n \"own_wallet_is_billable\": true,\n \"brand\": {\n \"id\": 65,\n \"org_id\": 39,\n \"primary_color\": {\n \"b\": 220,\n \"g\": 125,\n \"r\": 36\n },\n \"secondary_color\": {\n \"b\": 220,\n \"g\": 125,\n \"r\": 36\n },\n \"tertiary_color\": {\n \"b\": 220,\n \"g\": 125,\n \"r\": 36\n },\n \"email_primary_color\": {\n \"b\": 220,\n \"g\": 125,\n \"r\": 36\n },\n \"email_secondary_color\": {\n \"b\": 220,\n \"g\": 125,\n \"r\": 36\n },\n \"email_tertiary_color\": {\n \"b\": 220,\n \"g\": 125,\n \"r\": 36\n },\n \"logo\": {\n \"url\": \"https://hover.to/api/v1/orgs/39/brand/logo.png\",\n \"thumb\": {\n \"url\": \"https://hover.to/api/v1/orgs/39/brand/logo.png?version=thumb\"\n },\n \"nonretina\": {\n \"url\": \"https://hover.to/api/v1/orgs/39/brand/logo.png?version=nonretina\"\n },\n \"retina\": {\n \"url\": \"https://hover.to/api/v1/orgs/39/brand/logo.png?version=retina\"\n }\n },\n \"places_logo\": {\n \"url\": \"https://hover.to/api/v1/orgs/39/brand/places_logo.png\"\n },\n \"email_logo\": {\n \"url\": \"https://hover.to/api/v1/orgs/39/brand/email_logo.png\"\n },\n \"model_background_color\": {\n \"r\": 8,\n \"g\": 148,\n \"b\": 213\n },\n \"model_terrain_color\": {\n \"r\": 102,\n \"g\": 153,\n \"b\": 102\n }\n },\n \"settings\": {\n \"id\": 600550,\n \"org_id\": 600530,\n \"supports_openings_estimator\": false,\n \"needs_3d\": true,\n \"created_at\": \"2023-07-25T20:20:50.251Z\",\n \"updated_at\": \"2023-07-25T20:28:06.981Z\",\n \"auto_accept_users\": true,\n \"app_id\": null,\n \"machete_features\": [\n \"measurements\",\n \"share\",\n \"design\"\n ],\n \"supports_openings_instant_estimator\": false,\n \"supports_redirect_to_new_website\": true,\n \"supports_full_job_info_display\": true,\n \"supports_machete\": true,\n \"model_price\": 4995,\n \"payment_method\": \"credit_card\",\n \"privacy_url\": \"/privacy\",\n \"terms_url\": \"/terms_of_use\",\n \"supports_co_branded_pro_measurements\": false,\n \"config\": {\n \"reconstruction\": {\n \"vip_org\": false\n },\n \"hidden_attributes\": {\n \"Job\": {\n \"name\": false\n }\n },\n \"job_priority_overrides\": {\n \"homeowner_connect\": null,\n \"expedite_roof_only\": null,\n \"interior_homeowner_connect\": null\n }\n },\n \"priority\": 12,\n \"auto_invoice_enabled\": null,\n \"auto_invoice_day\": null,\n \"customer_account\": null,\n \"prepaid_quota\": 0,\n \"needs_texture\": true,\n \"supports_ordering\": false,\n \"supports_leads\": false,\n \"supports_wall_measurements\": true,\n \"supports_roof_measurements\": true,\n \"example_jobs_support\": false,\n \"example_jobs_selection_method\": 0,\n \"example_jobs_identifier\": null,\n \"app_name\": null,\n \"vip\": false,\n \"allow_waste_factor_preference\": null,\n \"invoiced\": false,\n \"hide_price_in_email\": false,\n \"only_design_pro_for_capture_request\": false,\n \"pre_select_capture_only_for_users\": false,\n \"exclude_capture_only\": false,\n \"interiors_priority\": 12,\n \"allow_homeowner_order_renderings\": false,\n \"show_design_studio\": false,\n \"locale\": \"en-US\",\n \"connect_message_template\": null,\n \"send_renderings_nudge_email\": false,\n \"commerce_product\": \"out_of_the_box_configuration\",\n \"exclude_from_bulk_enable_manufacturer\": false,\n \"allow_magic_link\": false,\n \"trial_enabled\": true,\n \"trial_start\": \"2023-07-25T20:20:50.392Z\",\n \"trial_period\": 0,\n \"trial_ends_at\": null,\n \"trial_remaining_jobs_allowed\": null,\n \"trial_expired\": false,\n \"auto_approve_roof_estimate\": false,\n \"capture_v2_enabled\": true\n },\n \"preferences\": {\n \"id\": 603634,\n \"org_id\": 600530,\n \"created_at\": \"2023-07-25T20:20:50.257Z\",\n \"updated_at\": \"2023-07-25T20:28:06.958Z\",\n \"default_acl_template\": \"pro_plus\",\n \"ordering_email\": \"\",\n \"preferred_siding_waste_factor\": null,\n \"preferred_roofing_waste_factor\": null,\n \"external_identifier_label\": \"Lead Number\",\n \"external_identifier_required\": false,\n \"include_pro_user_name_in_invite_messages\": true,\n \"deliverable_id\": null,\n \"external_identifier_strict_validation\": false\n },\n \"plan\": {\n \"id\": 154,\n \"name\": \"Pay As You Go\",\n \"partner_id\": 1,\n \"machete\": true,\n \"measurements\": true,\n \"measurements_branding\": false,\n \"ordering\": false,\n \"basic_export\": true,\n \"advanced_export\": true,\n \"basic_design\": true,\n \"advanced_design\": true,\n \"basic_team_management\": false,\n \"advanced_team_management\": true,\n \"created_at\": \"2017-04-18T18:01:06.462Z\",\n \"updated_at\": \"2023-05-05T19:53:47.483Z\",\n \"default\": false,\n \"visible\": true,\n \"sort_index\": 1,\n \"feature_icons\": null,\n \"feature_bullets\": null,\n \"email_receipt\": true,\n \"auto_assign_leads\": false,\n \"partner_analytics\": false,\n \"org_analytics\": false,\n \"allow_photo_only_capture\": true,\n \"homeowner_lead_capture\": false,\n \"plan_after_trial_id\": null,\n \"allows_instant_estimate\": true,\n \"allow_upgrade_to_pro\": true,\n \"allow_multi_family_residential_captures\": false,\n \"synced_monthly_with_stripe\": true,\n \"synced_yearly_with_stripe\": true,\n \"tier\": \"basic\",\n \"deleted\": false,\n \"deleted_at\": null,\n \"metadata\": {\n \"custom\": false\n },\n \"stripe_product_identifier\": \"prod_JapZ0j1ZdCf3cz\",\n \"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\",\n \"days_of_historical_job_access\": 0,\n \"partner\": {\n \"id\": 1,\n \"name\": \"Hover\",\n \"deliverable_ids\": [\n 2,\n 3,\n 7\n ],\n \"allow_deliverable_choice\": true,\n \"client_branding_logo_url\": null,\n \"allow_insurance_damage_capture\": false,\n \"allow_insurance_underwriting_capture\": false,\n \"identifier\": \"hover\"\n }\n },\n \"wallet\": {\n \"id\": 600442,\n \"org_id\": 600530,\n \"stripe_token\": null,\n \"created_at\": \"2023-07-25T20:20:50.380Z\",\n \"updated_at\": \"2023-07-25T20:20:50.380Z\",\n \"stripe_customer_identifier\": null,\n \"billing_address_line_1\": null,\n \"billing_address_line_2\": null,\n \"billing_address_city\": null,\n \"billing_address_region\": null,\n \"billing_address_postal_code\": null,\n \"billing_address_country\": null,\n \"billing_email\": null,\n \"card_brand\": null,\n \"card_last4\": null,\n \"cardholder_name\": null,\n \"card_expires_on\": null,\n \"last_error\": null,\n \"deleted\": false,\n \"deleted_at\": null,\n \"balance\": 0\n },\n \"billable_wallets\": [],\n \"features\": [\n {\n \"id\": 12023,\n \"accessor_id\": 154,\n \"accessor_type\": \"Plan\",\n \"enabled\": true,\n \"created_at\": \"2019-03-13T20:07:55.457Z\",\n \"updated_at\": \"2019-03-13T20:07:55.457Z\",\n \"identifier\": \"email_send_receipt\",\n \"deleted\": false,\n \"deleted_at\": null\n },\n {\n \"id\": 12024,\n \"accessor_id\": 154,\n \"accessor_type\": \"Plan\",\n \"enabled\": true,\n \"created_at\": \"2019-03-13T20:07:55.482Z\",\n \"updated_at\": \"2019-03-13T20:07:55.482Z\",\n \"identifier\": \"hover_now\",\n \"deleted\": false,\n \"deleted_at\": null\n },\n {\n \"id\": 12025,\n \"accessor_id\": 154,\n \"accessor_type\": \"Plan\",\n \"enabled\": true,\n \"created_at\": \"2019-03-13T20:07:55.495Z\",\n \"updated_at\": \"2019-03-13T20:07:55.495Z\",\n \"identifier\": \"prospect\",\n \"deleted\": false,\n \"deleted_at\": null\n },\n {\n \"id\": 12026,\n \"accessor_id\": 154,\n \"accessor_type\": \"Plan\",\n \"enabled\": true,\n \"created_at\": \"2019-03-13T20:07:55.506Z\",\n \"updated_at\": \"2019-03-13T20:07:55.506Z\",\n \"identifier\": \"design_view_measurements_tool\",\n \"deleted\": false,\n \"deleted_at\": null\n },\n {\n \"id\": 12665,\n \"accessor_id\": 154,\n \"accessor_type\": \"Plan\",\n \"enabled\": true,\n \"created_at\": \"2019-03-13T21:55:15.435Z\",\n \"updated_at\": \"2019-03-13T21:55:15.435Z\",\n \"identifier\": \"upgrade_to_pro\",\n \"deleted\": false,\n \"deleted_at\": null\n },\n {\n \"id\": 13849,\n \"accessor_id\": 154,\n \"accessor_type\": \"Plan\",\n \"enabled\": true,\n \"created_at\": \"2019-05-01T20:02:51.717Z\",\n \"updated_at\": \"2019-05-01T20:02:51.717Z\",\n \"identifier\": \"team_management_advanced\",\n \"deleted\": false,\n \"deleted_at\": null\n },\n {\n \"id\": 51579,\n \"accessor_id\": 154,\n \"accessor_type\": \"Plan\",\n \"enabled\": true,\n \"created_at\": \"2022-09-16T20:32:45.574Z\",\n \"updated_at\": \"2022-09-16T20:32:45.574Z\",\n \"identifier\": \"blueprints\",\n \"deleted\": false,\n \"deleted_at\": null\n },\n {\n \"id\": 113973,\n \"accessor_id\": 154,\n \"accessor_type\": \"Plan\",\n \"enabled\": true,\n \"created_at\": \"2023-05-05T19:53:47.494Z\",\n \"updated_at\": \"2023-05-05T19:53:47.494Z\",\n \"identifier\": \"hi_def_rendering\",\n \"deleted\": false,\n \"deleted_at\": null\n },\n {\n \"id\": 120638,\n \"accessor_id\": 600530,\n \"accessor_type\": \"Org\",\n \"enabled\": true,\n \"created_at\": \"2023-07-25T20:28:06.901Z\",\n \"updated_at\": \"2023-07-25T20:28:06.901Z\",\n \"identifier\": \"export_advanced_job\",\n \"deleted\": false,\n \"deleted_at\": null\n },\n {\n \"id\": 120639,\n \"accessor_id\": 600530,\n \"accessor_type\": \"Org\",\n \"enabled\": true,\n \"created_at\": \"2023-07-25T20:28:06.905Z\",\n \"updated_at\": \"2023-07-25T20:28:06.905Z\",\n \"identifier\": \"measurements_files_access\",\n \"deleted\": false,\n \"deleted_at\": null\n },\n {\n \"id\": 120640,\n \"accessor_id\": 600530,\n \"accessor_type\": \"Org\",\n \"enabled\": true,\n \"created_at\": \"2023-07-25T20:28:06.908Z\",\n \"updated_at\": \"2023-07-25T20:28:06.908Z\",\n \"identifier\": \"integrations\",\n \"deleted\": false,\n \"deleted_at\": null\n },\n {\n \"id\": 120641,\n \"accessor_id\": 600530,\n \"accessor_type\": \"Org\",\n \"enabled\": true,\n \"created_at\": \"2023-07-25T20:28:06.911Z\",\n \"updated_at\": \"2023-07-25T20:28:06.911Z\",\n \"identifier\": \"ehi_project_management_product\",\n \"deleted\": false,\n \"deleted_at\": null\n },\n {\n \"id\": 120642,\n \"accessor_id\": 600530,\n \"accessor_type\": \"Org\",\n \"enabled\": true,\n \"created_at\": \"2023-07-25T20:28:06.915Z\",\n \"updated_at\": \"2023-07-25T20:28:06.915Z\",\n \"identifier\": \"export_esx\",\n \"deleted\": false,\n \"deleted_at\": null\n },\n {\n \"id\": 120643,\n \"accessor_id\": 600530,\n \"accessor_type\": \"Org\",\n \"enabled\": true,\n \"created_at\": \"2023-07-25T20:28:06.918Z\",\n \"updated_at\": \"2023-07-25T20:28:06.918Z\",\n \"identifier\": \"sequential_capture\",\n \"deleted\": false,\n \"deleted_at\": null\n },\n {\n \"id\": 120644,\n \"accessor_id\": 600530,\n \"accessor_type\": \"Org\",\n \"enabled\": true,\n \"created_at\": \"2023-07-25T20:28:06.921Z\",\n \"updated_at\": \"2023-07-25T20:28:06.921Z\",\n \"identifier\": \"out_of_the_box_material_lists\",\n \"deleted\": false,\n \"deleted_at\": null\n },\n {\n \"id\": 120645,\n \"accessor_id\": 600530,\n \"accessor_type\": \"Org\",\n \"enabled\": true,\n \"created_at\": \"2023-07-25T20:28:06.924Z\",\n \"updated_at\": \"2023-07-25T20:28:06.924Z\",\n \"identifier\": \"blueprints_commercial\",\n \"deleted\": false,\n \"deleted_at\": null\n },\n {\n \"id\": 120646,\n \"accessor_id\": 600530,\n \"accessor_type\": \"Org\",\n \"enabled\": true,\n \"created_at\": \"2023-07-25T20:28:06.927Z\",\n \"updated_at\": \"2023-07-25T20:28:06.927Z\",\n \"identifier\": \"blueprints_interior_job_type\",\n \"deleted\": false,\n \"deleted_at\": null\n },\n {\n \"id\": 120647,\n \"accessor_id\": 600530,\n \"accessor_type\": \"Org\",\n \"enabled\": true,\n \"created_at\": \"2023-07-25T20:28:06.929Z\",\n \"updated_at\": \"2023-07-25T20:28:06.929Z\",\n \"identifier\": \"inspection_checklist\",\n \"deleted\": false,\n \"deleted_at\": null\n }\n ]\n },\n \"pending_capture_request\": null,\n \"capture_request\": null,\n \"roof_estimate\": null\n }\n}\n\n ```", "operationId": "createAJob", "requestBody": { "content": { "multipart/form-data": { "schema": { "type": "object", "properties": { "current_user_email": { "description": "Required. The internal user that you want to assign the job to. Alternatively you can also use the current_user_id param.", "type": "string", "example": "" }, "current_user_id": { "type": "string", "example": "" }, "job[customer_email]": { "description": "The email address of the customer. Usually the homeowner.", "type": "string", "example": "homeowner@hover.to" }, "job[customer_name]": { "description": "The name of the customer. Usually the homeowner.", "type": "string", "example": "Michael Bluth" }, "job[customer_phone]": { "description": "The phone number of the customer. Usually the homeowner.", "type": "string", "example": "5558675309" }, "job[deliverable_id]": { "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)", "type": "string", "example": "3" }, "job[external_identifier]": { "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 client application's database.", "type": "string", "example": "54965" }, "job[location_city]": { "description": "The city of this job's address", "type": "string", "example": "Los Angeles" }, "job[location_country]": { "description": "The postal code of this job's address", "type": "string", "example": "US" }, "job[location_line_1]": { "description": "First line of this job's address", "type": "string", "example": "123 HOVER Way" }, "job[location_line_2]": { "description": "Second line of this job's address", "type": "string", "example": "" }, "job[location_postal_code]": { "description": "The postal code of this job's address", "type": "string", "example": "90210" }, "job[location_region]": { "description": "The state of this job's address", "type": "string", "example": "CA" }, "job[name]": { "description": "A name for this job.", "type": "string", "example": "Bluth Development House 1" }, "job[suppress_email]": { "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.", "type": "string", "example": "" } } } } } }, "responses": { "201": { "description": "201 Created", "headers": { "Alt-Svc": { "schema": { "type": "string", "example": "h3=\":443\"; ma=86400" } }, "CF-Cache-Status": { "schema": { "type": "string", "example": "DYNAMIC" } }, "CF-Ray": { "schema": { "type": "string", "example": "7ec7f85b1d839452-SJC" } }, "Cache-Control": { "schema": { "type": "string", "example": "max-age=0, private, must-revalidate" } }, "Connection": { "schema": { "type": "string", "example": "keep-alive" } }, "Content-Length": { "schema": { "type": "string", "example": "22540" } }, "Date": { "schema": { "type": "string", "example": "Tue, 25 Jul 2023 22:51:53 GMT" } }, "ETag": { "schema": { "type": "string", "example": "W/\"f02b645a94a580f16bcd51ce64ff83d0\"" } }, "Location": { "schema": { "type": "string", "example": "/api/v1/jobs/9824755" } }, "Referrer-Policy": { "schema": { "type": "string", "example": "strict-origin-when-cross-origin" } }, "Server": { "schema": { "type": "string", "example": "cloudflare" } }, "Set-Cookie": { "schema": { "type": "string", "example": "_hyperion_session=ecfea63a3fec9c30625550e4c86ba741; domain=.hover.to; path=/; expires=Thu, 24 Aug 2023 22:51:53 GMT; secure; HttpOnly; SameSite=Lax" } }, "Strict-Transport-Security": { "schema": { "type": "string", "example": "max-age=0" } }, "Vary": { "schema": { "type": "string", "example": "Origin, Accept-Encoding" } }, "Via": { "schema": { "type": "string", "example": "1.1 google" } }, "X-Content-Type-Options": { "schema": { "type": "string", "example": "nosniff" } }, "X-Download-Options": { "schema": { "type": "string", "example": "noopen" } }, "X-Frame-Options": { "schema": { "type": "string", "example": "ALLOWALL" } }, "X-Permitted-Cross-Domain-Policies": { "schema": { "type": "string", "example": "none" } }, "X-Request-Id": { "schema": { "type": "string", "example": "8824c805-42c5-439a-9ca1-e099d9a4095b" } }, "X-Runtime": { "schema": { "type": "string", "example": "0.335121" } }, "X-XSS-Protection": { "schema": { "type": "string", "example": "0" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "job": { "type": "object", "properties": { "additional_captured_jobs": { "type": "array", "items": {}, "example": [] }, "additional_information": { "nullable": true, "example": null }, "approved": { "type": "boolean", "example": true }, "archived": { "type": "boolean", "example": false }, "blueprint": { "type": "boolean", "example": false }, "can_access_hi_def_rendering": { "type": "boolean", "example": true }, "can_order_hi_def_rendering": { "type": "boolean", "example": true }, "can_request_hi_def_rendering": { "type": "boolean", "example": true }, "capture_request": { "nullable": true, "example": null }, "capture_session_identifier": { "nullable": true, "example": null }, "client_identifier": { "type": "string", "example": "521b9a3b-759b-49ea-9b1e-7632aec3f45a" }, "complete_expedited": { "type": "boolean", "example": false }, "completed_at": { "nullable": true, "example": null }, "contractor_estimate_sent_to": { "nullable": true, "example": null }, "created_at": { "type": "string", "example": "2023-07-25T22:51:53.552Z" }, "customer_contact": { "nullable": true, "example": null }, "customer_contact_only_by_email": { "type": "boolean", "example": false }, "customer_email": { "type": "string", "example": "homeowner@hover.to" }, "customer_first_name": { "nullable": true, "example": null }, "customer_name": { "type": "string", "example": "Michael Bluth" }, "customer_notes": { "nullable": true, "example": null }, "customer_phone": { "type": "string", "example": "5558675309" }, "deliverable_id": { "type": "number", "example": 3 }, "estimated_hours_to_completion": { "type": "number", "example": 0 }, "example": { "type": "boolean", "example": false }, "external_identifier": { "type": "string", "example": "54965" }, "external_identifier_label": { "type": "string", "example": "Lead Number" }, "file_attachments": { "type": "array", "items": {}, "example": [] }, "hero_image": { "nullable": true, "example": null }, "id": { "type": "number", "example": 9824755 }, "job_assignments": { "type": "array", "items": { "type": "object", "properties": { "archived": { "type": "boolean", "example": false }, "archived_at": { "nullable": true, "example": null }, "assigned_by": { "nullable": true, "example": null }, "created_at": { "type": "string", "example": "2023-07-25T22:51:53.577Z" }, "id": { "type": "number", "example": 14905200 }, "job_id": { "type": "number", "example": 9824755 }, "kind": { "type": "string", "example": "creator" }, "org": { "type": "object", "properties": { "ancestral_name": { "type": "string", "example": "HOVER > Pro > Salesforce Package Development > Developer Docs Org" }, "customer_display_name": { "type": "string", "example": "Developer Docs Org" }, "id": { "type": "number", "example": 600530 }, "kind": { "type": "string", "example": "dealer" }, "model_price": { "type": "number", "example": 4995 }, "name": { "type": "string", "example": "Developer Docs Org" }, "ordering_email": { "type": "string", "example": "" }, "parent_id": { "type": "number", "example": 492855 }, "sort_order": { "nullable": true, "example": null }, "updated_at": { "type": "string", "example": "2023-07-25T20:28:07.766Z" } } }, "updated_at": { "type": "string", "example": "2023-07-25T22:51:53.577Z" }, "user": { "type": "object", "properties": { "aasm_state": { "type": "string", "example": "activated" }, "email": { "type": "string", "example": "geoff.hull+devdocs@hoverinc.com" }, "first_name": { "type": "string", "example": "Geoff" }, "id": { "type": "number", "example": 1537006 }, "last_name": { "type": "string", "example": "Hull" }, "preferred_identifier": { "nullable": true, "example": null }, "require_job_approval": { "type": "boolean", "example": false }, "sign_in_count": { "type": "number", "example": 0 }, "time_zone": { "type": "string", "example": "Pacific Time (US & Canada)" } } }, "user_id": { "type": "number", "example": 1537006 } } }, "example": [ { "archived": false, "archived_at": null, "assigned_by": null, "created_at": "2023-07-25T22:51:53.577Z", "id": 14905200, "job_id": 9824755, "kind": "creator", "org": { "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "customer_display_name": "Developer Docs Org", "id": 600530, "kind": "dealer", "model_price": 4995, "name": "Developer Docs Org", "ordering_email": "", "parent_id": 492855, "sort_order": null, "updated_at": "2023-07-25T20:28:07.766Z" }, "updated_at": "2023-07-25T22:51:53.577Z", "user": { "aasm_state": "activated", "email": "geoff.hull+devdocs@hoverinc.com", "first_name": "Geoff", "id": 1537006, "last_name": "Hull", "preferred_identifier": null, "require_job_approval": false, "sign_in_count": 0, "time_zone": "Pacific Time (US & Canada)" }, "user_id": 1537006 } ] }, "job_shares": { "type": "array", "items": {}, "example": [] }, "location": { "type": "object", "properties": { "city": { "type": "string", "example": "Los Angeles" }, "country": { "type": "string", "example": "US" }, "line_1": { "type": "string", "example": "123 HOVER Way" }, "line_2": { "type": "string", "example": "" }, "postal_code": { "type": "string", "example": "90210" }, "region": { "type": "string", "example": "CA" } } }, "location_city": { "type": "string", "example": "Los Angeles" }, "location_country": { "type": "string", "example": "US" }, "location_lat": { "nullable": true, "example": null }, "location_line_1": { "type": "string", "example": "123 HOVER Way" }, "location_line_2": { "type": "string", "example": "" }, "location_lon": { "nullable": true, "example": null }, "location_postal_code": { "type": "string", "example": "90210" }, "location_region": { "type": "string", "example": "CA" }, "machete_blob": { "type": "object", "properties": { "DesignFeature": { "type": "object", "properties": { "labelsSrc": { "type": "string", "example": "https://hover.to/hover_models/labels.json" }, "manufacturerProductsSrc": { "type": "string", "example": "https://products.hover.to/hover_models/manufacturer_products.json" }, "manufacturersSrc": { "type": "string", "example": "https://products.hover.to/hover_models/manufacturers.json?provider_ids%5B%5D=56&provider_ids%5B%5D=57&provider_ids%5B%5D=58&provider_ids%5B%5D=59&provider_ids%5B%5D=91&provider_ids%5B%5D=1&provider_ids%5B%5D=2&provider_ids%5B%5D=6&provider_ids%5B%5D=7&provider_ids%5B%5D=3&provider_ids%5B%5D=9&provider_ids%5B%5D=11&provider_ids%5B%5D=5&provider_ids%5B%5D=12&provider_ids%5B%5D=14&provider_ids%5B%5D=15&provider_ids%5B%5D=16&provider_ids%5B%5D=17&provider_ids%5B%5D=18&provider_ids%5B%5D=225&provider_ids%5B%5D=54&provider_ids%5B%5D=4&provider_ids%5B%5D=371&provider_ids%5B%5D=52&provider_ids%5B%5D=389&provider_ids%5B%5D=424&provider_ids%5B%5D=1745&provider_ids%5B%5D=1749&provider_ids%5B%5D=8&provider_ids%5B%5D=1756&provider_ids%5B%5D=1201&provider_ids%5B%5D=8485&provider_ids%5B%5D=5839&provider_ids%5B%5D=8532&provider_ids%5B%5D=8502" }, "productsSrc": { "type": "string", "example": "https://products.hover.to/hover_models/products.json" }, "showWindowColors": { "type": "boolean", "example": false } } }, "DesignPro": { "type": "object", "properties": { "usePBRMode": { "type": "boolean", "example": false } } }, "InfoFeature": { "type": "object", "properties": { "address": { "type": "string", "example": "123 HOVER Way" }, "username": { "type": "string", "example": "HOVER" } } }, "MeasurementsFeature": { "type": "object", "properties": { "includeOpenings": { "type": "boolean", "example": true }, "includePremiumMeasurements": { "type": "boolean", "example": true }, "includeProMeasurements": { "type": "boolean", "example": true }, "includeRoof": { "type": "boolean", "example": true }, "includeSurfaceAreas": { "type": "boolean", "example": true }, "includeWalls": { "type": "boolean", "example": true }, "labelsSrc": { "type": "string", "example": "https://hover.to/hover_models/labels.json" }, "measurementsSrc": { "type": "string", "example": "https://hover.to/api/v1/models/9822327/machete_model_measurements" }, "useMetricSystem": { "type": "boolean", "example": false } } }, "OptInFeature": { "type": "object", "properties": { "designProUrl": { "type": "string", "example": "https://hover.to/3d/9824755" }, "enabled": { "type": "boolean", "example": true } } }, "PlanetTerror": { "type": "object", "properties": { "manufacturerProductsSrc": { "type": "string", "example": "https://products.hover.to/hover_models/manufacturer_products.json" }, "manufacturersSrc": { "type": "string", "example": "https://products.hover.to/hover_models/manufacturers.json?provider_ids%5B%5D=56&provider_ids%5B%5D=57&provider_ids%5B%5D=58&provider_ids%5B%5D=59&provider_ids%5B%5D=91&provider_ids%5B%5D=1&provider_ids%5B%5D=2&provider_ids%5B%5D=6&provider_ids%5B%5D=7&provider_ids%5B%5D=3&provider_ids%5B%5D=9&provider_ids%5B%5D=11&provider_ids%5B%5D=5&provider_ids%5B%5D=12&provider_ids%5B%5D=14&provider_ids%5B%5D=15&provider_ids%5B%5D=16&provider_ids%5B%5D=17&provider_ids%5B%5D=18&provider_ids%5B%5D=225&provider_ids%5B%5D=54&provider_ids%5B%5D=4&provider_ids%5B%5D=371&provider_ids%5B%5D=52&provider_ids%5B%5D=389&provider_ids%5B%5D=424&provider_ids%5B%5D=1745&provider_ids%5B%5D=1749&provider_ids%5B%5D=8&provider_ids%5B%5D=1756&provider_ids%5B%5D=1201&provider_ids%5B%5D=8485&provider_ids%5B%5D=5839&provider_ids%5B%5D=8532&provider_ids%5B%5D=8502" }, "productsSrc": { "type": "string", "example": "https://products.hover.to/hover_models/products.json" } } }, "ShareFeature": { "type": "object", "properties": {} }, "geometrySrc": { "type": "string", "example": "https://hover.to/api/v1/models/9822327/model_json_v3" }, "metadataSrc": { "type": "string", "example": "https://hover.to/api/v1/models/9822327/machete" }, "productsSrc": { "type": "string", "example": "https://products.hover.to/hover_models/products.json" }, "useDesignFeature": { "type": "boolean", "example": true }, "useDesignPro": { "type": "boolean", "example": true }, "useInfoFeature": { "type": "boolean", "example": true }, "useLabsFeature": { "type": "boolean", "example": false }, "useMeasurementsFeature": { "type": "boolean", "example": true }, "useOptInFeature": { "type": "boolean", "example": true }, "useShareFeature": { "type": "boolean", "example": true } } }, "machete_features": { "type": "array", "items": { "type": "string", "example": "ShareFeature" }, "example": [ "ShareFeature", "MeasurementsFeature", "DesignFeature" ] }, "models": { "type": "array", "items": { "type": "object", "properties": { "address": { "nullable": true, "example": null }, "archive_number": { "nullable": true, "example": null }, "archived": { "type": "boolean", "example": false }, "archived_at": { "nullable": true, "example": null }, "atlas": { "nullable": true, "example": null }, "cameras": { "type": "object", "properties": {} }, "complexity_attributes": { "nullable": true, "example": null }, "complexity_score": { "type": "string", "example": "large" }, "created_at": { "type": "string", "example": "2023-07-25T22:51:53.601Z" }, "created_with_job": { "type": "boolean", "example": true }, "cv_data": { "type": "object", "properties": {} }, "dense_capture": { "nullable": true, "example": null }, "export": { "nullable": true, "example": null }, "failure_reason": { "nullable": true, "example": null }, "footprint_to_a": { "type": "array", "items": {}, "example": [] }, "id": { "type": "number", "example": 9822327 }, "image_archive": { "type": "object", "properties": { "cloudfront_upload_url": { "type": "string", "example": "https://hover.to/Hyperion/Model/9822327/image_archive.zip?response-content-type=application%2Foctet-stream&Expires=1690671113&Signature=CzuHdJWtG9OG2w1Tq1oa7NnQGsVy3MAJ4klSnjtnJ86cCvO55etKejEsuZm~Qdx9~zJihJUebIUA6C-517i-iwgivI8aZaBRbnhaRy1NjdlAIjeb7S6WjmaDMC-7rSgRhzYjDqOFgkGrq2~8QVK7BxHYY75WbhSWc9A-BX8XxyuvXzMy1pcNgiBaNFV63scWt5DRFMuV1bKrYKcVxwPKpkZpQSZpqsW588PGau1aAyLy-4pIi--5QImWAjUKbyKZiSoqultlUZeTBz4s2FDwpEIRlLSXr6Yq55ZBxoWHI87tkR5BGokXzyRjYiS9LyPwyhFTpIFYU~OyHVM2gv6foA__&Key-Pair-Id=APKAJOCSUB5UYQFW7A5Q" }, "high_res": { "type": "object", "properties": { "cloudfront_upload_url": { "type": "string", "example": "https://hover.to/Hyperion/Model/9822327/image_archive_high_res.zip?response-content-type=application%2Foctet-stream&Expires=1690671113&Signature=HO6B1CQrA30qCAwiU27nf-H7rX9Q4hNZhsE8H00-~o6PSh4SvCp5lKz87E74w2WzSomh8B8uzN0jKBOOKhROm6KGURS7E6SVycYaN58s7fm42hd2ogeSYPMUovNzoauzPzAG43iuBLMvpIX4MKxjSiLYl5M40OAHVvD3OfEXtJCdvYaiyPw97lOdAf2m7nBg2SDENXQ1CPPNxganQVvX8uu3lyxKy53gqnWvLGi~7mjUHj6qxT9hfnuCtd9hH8AZRKCjkho6SoYSqigX7e-1Su~IsScaHJ9m4VRXnKTRya-~l19Opfu4PMdFtv1L5TjyWZCiGje~GVDz~mZqVaCbrA__&Key-Pair-Id=APKAJOCSUB5UYQFW7A5Q" }, "upload_url": { "type": "string", "example": "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%2F20230725%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230725T225153Z&X-Amz-Expires=345600&X-Amz-SignedHeaders=host&X-Amz-Signature=279ddcfc3625c53e623c2114f70fb0f598f82d67f8042f179640dc9c35e366bf" } } }, "upload_url": { "type": "string", "example": "https://s3.amazonaws.com/files.production.hover.to/Hyperion/Model/9822327/image_archive.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIATQULT2KNHFWYSSCT%2F20230725%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230725T225153Z&X-Amz-Expires=345600&X-Amz-SignedHeaders=host&X-Amz-Signature=0667873ea91eb56767bd2c1a95848f491cda8e59bd85c65235aa93d7b9c52ec5" } } }, "images": { "type": "array", "items": {}, "example": [] }, "important_changed_areas_to_notify_user_about": { "nullable": true, "example": null }, "interior_floor_plan_measurements": { "nullable": true, "example": null }, "is_3d_available": { "type": "boolean", "example": false }, "job_id": { "type": "number", "example": 9824755 }, "machete": { "nullable": true, "example": null }, "machete_model_measurements": { "type": "object", "properties": {} }, "manowar_identifier": { "nullable": true, "example": null }, "manually_uploaded_by_id": { "nullable": true, "example": null }, "measurement_results_s3_key": { "nullable": true, "example": null }, "message_to_production_team": { "nullable": true, "example": null }, "model_json_v3": { "nullable": true, "example": null }, "modeling_status": { "nullable": true, "example": null }, "original_model_id": { "nullable": true, "example": null }, "payment_method": { "type": "string", "example": "free" }, "polygon": { "nullable": true, "example": null }, "position_wgs": { "type": "array", "items": {}, "example": [] }, "pro_measurements": { "nullable": true, "example": null }, "pro_premium_measurements": { "nullable": true, "example": null }, "reprocessed": { "type": "boolean", "example": false }, "roof_measurements": { "nullable": true, "example": null }, "siding_report": { "nullable": true, "example": null }, "state": { "type": "string", "example": "uploading" }, "structured_mesh": { "type": "object", "properties": {} }, "token": { "nullable": true, "example": null }, "total_living_area_measurements": { "nullable": true, "example": null }, "total_living_area_plus_measurements": { "nullable": true, "example": null }, "tracking_log": { "type": "object", "properties": {} }, "unstructured_mesh": { "type": "object", "properties": {} }, "updated_at": { "type": "string", "example": "2023-07-25T22:51:53.612Z" }, "video": { "nullable": true, "example": null }, "wireframe_back": { "type": "object", "properties": {} }, "wireframe_back_left": { "type": "object", "properties": {} }, "wireframe_footprint": { "type": "object", "properties": {} }, "wireframe_front": { "type": "object", "properties": {} }, "wireframe_front_right": { "type": "object", "properties": {} }, "wireframe_left": { "type": "object", "properties": {} }, "wireframe_left_front": { "type": "object", "properties": {} }, "wireframe_right": { "type": "object", "properties": {} }, "wireframe_right_back": { "type": "object", "properties": {} }, "wireframe_roof": { "type": "object", "properties": {} }, "wireframe_total_living_area": { "type": "object", "properties": {} } } }, "example": [ { "address": null, "archive_number": null, "archived": false, "archived_at": null, "atlas": null, "cameras": {}, "complexity_attributes": null, "complexity_score": "large", "created_at": "2023-07-25T22:51:53.601Z", "created_with_job": true, "cv_data": {}, "dense_capture": null, "export": null, "failure_reason": null, "footprint_to_a": [], "id": 9822327, "image_archive": { "cloudfront_upload_url": "https://hover.to/Hyperion/Model/9822327/image_archive.zip?response-content-type=application%2Foctet-stream&Expires=1690671113&Signature=CzuHdJWtG9OG2w1Tq1oa7NnQGsVy3MAJ4klSnjtnJ86cCvO55etKejEsuZm~Qdx9~zJihJUebIUA6C-517i-iwgivI8aZaBRbnhaRy1NjdlAIjeb7S6WjmaDMC-7rSgRhzYjDqOFgkGrq2~8QVK7BxHYY75WbhSWc9A-BX8XxyuvXzMy1pcNgiBaNFV63scWt5DRFMuV1bKrYKcVxwPKpkZpQSZpqsW588PGau1aAyLy-4pIi--5QImWAjUKbyKZiSoqultlUZeTBz4s2FDwpEIRlLSXr6Yq55ZBxoWHI87tkR5BGokXzyRjYiS9LyPwyhFTpIFYU~OyHVM2gv6foA__&Key-Pair-Id=APKAJOCSUB5UYQFW7A5Q", "high_res": { "cloudfront_upload_url": "https://hover.to/Hyperion/Model/9822327/image_archive_high_res.zip?response-content-type=application%2Foctet-stream&Expires=1690671113&Signature=HO6B1CQrA30qCAwiU27nf-H7rX9Q4hNZhsE8H00-~o6PSh4SvCp5lKz87E74w2WzSomh8B8uzN0jKBOOKhROm6KGURS7E6SVycYaN58s7fm42hd2ogeSYPMUovNzoauzPzAG43iuBLMvpIX4MKxjSiLYl5M40OAHVvD3OfEXtJCdvYaiyPw97lOdAf2m7nBg2SDENXQ1CPPNxganQVvX8uu3lyxKy53gqnWvLGi~7mjUHj6qxT9hfnuCtd9hH8AZRKCjkho6SoYSqigX7e-1Su~IsScaHJ9m4VRXnKTRya-~l19Opfu4PMdFtv1L5TjyWZCiGje~GVDz~mZqVaCbrA__&Key-Pair-Id=APKAJOCSUB5UYQFW7A5Q", "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%2F20230725%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230725T225153Z&X-Amz-Expires=345600&X-Amz-SignedHeaders=host&X-Amz-Signature=279ddcfc3625c53e623c2114f70fb0f598f82d67f8042f179640dc9c35e366bf" }, "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%2F20230725%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230725T225153Z&X-Amz-Expires=345600&X-Amz-SignedHeaders=host&X-Amz-Signature=0667873ea91eb56767bd2c1a95848f491cda8e59bd85c65235aa93d7b9c52ec5" }, "images": [], "important_changed_areas_to_notify_user_about": null, "interior_floor_plan_measurements": null, "is_3d_available": false, "job_id": 9824755, "machete": null, "machete_model_measurements": {}, "manowar_identifier": null, "manually_uploaded_by_id": null, "measurement_results_s3_key": null, "message_to_production_team": null, "model_json_v3": null, "modeling_status": null, "original_model_id": null, "payment_method": "free", "polygon": null, "position_wgs": [], "pro_measurements": null, "pro_premium_measurements": null, "reprocessed": false, "roof_measurements": null, "siding_report": null, "state": "uploading", "structured_mesh": {}, "token": null, "total_living_area_measurements": null, "total_living_area_plus_measurements": null, "tracking_log": {}, "unstructured_mesh": {}, "updated_at": "2023-07-25T22:51:53.612Z", "video": null, "wireframe_back": {}, "wireframe_back_left": {}, "wireframe_footprint": {}, "wireframe_front": {}, "wireframe_front_right": {}, "wireframe_left": {}, "wireframe_left_front": {}, "wireframe_right": {}, "wireframe_right_back": {}, "wireframe_roof": {}, "wireframe_total_living_area": {} } ] }, "name": { "type": "string", "example": "Bluth Development House 1" }, "org_id": { "type": "number", "example": 600530 }, "org_job_accesses": { "type": "array", "items": { "type": "object", "properties": { "archived": { "type": "boolean", "example": false }, "archived_at": { "nullable": true, "example": null }, "created_at": { "type": "string", "example": "2023-07-25T22:51:53.561Z" }, "id": { "type": "number", "example": 12565107 }, "job_id": { "type": "number", "example": 9824755 }, "kind": { "type": "string", "example": "creator" }, "lead_state": { "type": "string", "example": "assigned" }, "ordering_state": { "type": "string", "example": "lead" }, "org": { "type": "object", "properties": { "ancestral_name": { "type": "string", "example": "HOVER > Pro > Salesforce Package Development > Developer Docs Org" }, "customer_display_name": { "type": "string", "example": "Developer Docs Org" }, "id": { "type": "number", "example": 600530 }, "kind": { "type": "string", "example": "dealer" }, "model_price": { "type": "number", "example": 4995 }, "name": { "type": "string", "example": "Developer Docs Org" }, "ordering_email": { "type": "string", "example": "" }, "parent_id": { "type": "number", "example": 492855 }, "sort_order": { "nullable": true, "example": null }, "updated_at": { "type": "string", "example": "2023-07-25T20:28:07.766Z" } } }, "owner": { "type": "object", "properties": { "ancestral_name": { "type": "string", "example": "HOVER > Pro > Salesforce Package Development > Developer Docs Org" }, "customer_display_name": { "type": "string", "example": "Developer Docs Org" }, "id": { "type": "number", "example": 600530 }, "kind": { "type": "string", "example": "dealer" }, "model_price": { "type": "number", "example": 4995 }, "name": { "type": "string", "example": "Developer Docs Org" }, "ordering_email": { "type": "string", "example": "" }, "parent_id": { "type": "number", "example": 492855 }, "sort_order": { "nullable": true, "example": null }, "updated_at": { "type": "string", "example": "2023-07-25T20:28:07.766Z" } } }, "via_job_share": { "nullable": true, "example": null } } }, "example": [ { "archived": false, "archived_at": null, "created_at": "2023-07-25T22:51:53.561Z", "id": 12565107, "job_id": 9824755, "kind": "creator", "lead_state": "assigned", "ordering_state": "lead", "org": { "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "customer_display_name": "Developer Docs Org", "id": 600530, "kind": "dealer", "model_price": 4995, "name": "Developer Docs Org", "ordering_email": "", "parent_id": 492855, "sort_order": null, "updated_at": "2023-07-25T20:28:07.766Z" }, "owner": { "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "customer_display_name": "Developer Docs Org", "id": 600530, "kind": "dealer", "model_price": 4995, "name": "Developer Docs Org", "ordering_email": "", "parent_id": 492855, "sort_order": null, "updated_at": "2023-07-25T20:28:07.766Z" }, "via_job_share": null } ] }, "org_name": { "type": "string", "example": "Developer Docs Org" }, "orgs": { "type": "array", "items": { "type": "object", "properties": { "ancestral_name": { "type": "string", "example": "HOVER > Pro > Salesforce Package Development > Developer Docs Org" }, "customer_display_name": { "type": "string", "example": "Developer Docs Org" }, "id": { "type": "number", "example": 600530 }, "kind": { "type": "string", "example": "dealer" }, "model_price": { "type": "number", "example": 4995 }, "name": { "type": "string", "example": "Developer Docs Org" }, "ordering_email": { "type": "string", "example": "" }, "parent_id": { "type": "number", "example": 492855 }, "sort_order": { "nullable": true, "example": null }, "updated_at": { "type": "string", "example": "2023-07-25T20:28:07.766Z" } } }, "example": [ { "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "customer_display_name": "Developer Docs Org", "id": 600530, "kind": "dealer", "model_price": 4995, "name": "Developer Docs Org", "ordering_email": "", "parent_id": 492855, "sort_order": null, "updated_at": "2023-07-25T20:28:07.766Z" } ] }, "pending_capture_request": { "nullable": true, "example": null }, "property_type": { "type": "string", "example": "single_family_residential" }, "roof_estimate": { "nullable": true, "example": null }, "roof_estimate_access_level": { "type": "string", "example": "instant" }, "roof_estimate_presold": { "type": "boolean", "example": false }, "roof_estimate_purchase_state": { "nullable": true, "example": null }, "roof_estimate_supported": { "type": "boolean", "example": true }, "shared": { "type": "boolean", "example": false }, "state": { "type": "string", "example": "uploading" }, "suppress_email": { "nullable": true, "example": null }, "symbility_xml_url": { "nullable": true, "example": null }, "through_org": { "type": "object", "properties": { "ancestral_name": { "type": "string", "example": "HOVER > Pro > Salesforce Package Development > Developer Docs Org" }, "available_deliverable_ids": { "type": "array", "items": { "type": "number", "example": 2 }, "example": [ 2, 3, 7 ] }, "billable_wallets": { "type": "array", "items": {}, "example": [] }, "brand": { "type": "object", "properties": { "email_logo": { "type": "object", "properties": { "url": { "type": "string", "example": "https://hover.to/api/v1/orgs/39/brand/email_logo.png" } } }, "email_primary_color": { "type": "object", "properties": { "b": { "type": "number", "example": 220 }, "g": { "type": "number", "example": 125 }, "r": { "type": "number", "example": 36 } } }, "email_secondary_color": { "type": "object", "properties": { "b": { "type": "number", "example": 220 }, "g": { "type": "number", "example": 125 }, "r": { "type": "number", "example": 36 } } }, "email_tertiary_color": { "type": "object", "properties": { "b": { "type": "number", "example": 220 }, "g": { "type": "number", "example": 125 }, "r": { "type": "number", "example": 36 } } }, "id": { "type": "number", "example": 65 }, "logo": { "type": "object", "properties": { "nonretina": { "type": "object", "properties": { "url": { "type": "string", "example": "https://hover.to/api/v1/orgs/39/brand/logo.png?version=nonretina" } } }, "retina": { "type": "object", "properties": { "url": { "type": "string", "example": "https://hover.to/api/v1/orgs/39/brand/logo.png?version=retina" } } }, "thumb": { "type": "object", "properties": { "url": { "type": "string", "example": "https://hover.to/api/v1/orgs/39/brand/logo.png?version=thumb" } } }, "url": { "type": "string", "example": "https://hover.to/api/v1/orgs/39/brand/logo.png" } } }, "model_background_color": { "type": "object", "properties": { "b": { "type": "number", "example": 213 }, "g": { "type": "number", "example": 148 }, "r": { "type": "number", "example": 8 } } }, "model_terrain_color": { "type": "object", "properties": { "b": { "type": "number", "example": 102 }, "g": { "type": "number", "example": 153 }, "r": { "type": "number", "example": 102 } } }, "org_id": { "type": "number", "example": 39 }, "places_logo": { "type": "object", "properties": { "url": { "type": "string", "example": "https://hover.to/api/v1/orgs/39/brand/places_logo.png" } } }, "primary_color": { "type": "object", "properties": { "b": { "type": "number", "example": 220 }, "g": { "type": "number", "example": 125 }, "r": { "type": "number", "example": 36 } } }, "secondary_color": { "type": "object", "properties": { "b": { "type": "number", "example": 220 }, "g": { "type": "number", "example": 125 }, "r": { "type": "number", "example": 36 } } }, "tertiary_color": { "type": "object", "properties": { "b": { "type": "number", "example": 220 }, "g": { "type": "number", "example": 125 }, "r": { "type": "number", "example": 36 } } } } }, "client_branding_logo_url": { "nullable": true, "example": null }, "created_at": { "type": "string", "example": "2023-07-25T20:20:50.240Z" }, "cust_serv_city": { "nullable": true, "example": null }, "cust_serv_contact": { "nullable": true, "example": null }, "cust_serv_line_1": { "nullable": true, "example": null }, "cust_serv_line_2": { "nullable": true, "example": null }, "cust_serv_name": { "nullable": true, "example": null }, "cust_serv_phone": { "nullable": true, "example": null }, "cust_serv_postal_code": { "nullable": true, "example": null }, "cust_serv_region": { "nullable": true, "example": null }, "customer_display_name": { "type": "string", "example": "Developer Docs Org" }, "deliverable_id": { "nullable": true, "example": null }, "deliverable_ids": { "type": "array", "items": { "type": "number", "example": 2 }, "example": [ 2, 3, 7 ] }, "discounts": { "type": "array", "items": { "type": "object", "properties": { "blueprint_job_fixed_amount": { "type": "number", "example": 0 }, "blueprint_job_percent": { "type": "number", "example": 0 }, "code": { "nullable": true, "example": null }, "days_to_live": { "type": "number", "example": 0 }, "expires_at": { "nullable": true, "example": null }, "hi_def_rendering_version_fixed_amount": { "type": "number", "example": 0 }, "hi_def_rendering_version_percent": { "type": "number", "example": 0 }, "hover_models_roof_estimate_fixed_amount": { "type": "number", "example": 0 }, "hover_models_roof_estimate_percent": { "type": "number", "example": 0 }, "id": { "type": "number", "example": 5085 }, "internal_description": { "nullable": true, "example": null }, "job_fixed_amount": { "type": "number", "example": 0 }, "job_percent": { "type": "number", "example": 0 }, "maximum_condition": { "nullable": true, "example": null }, "minimum_condition": { "nullable": true, "example": null }, "name": { "type": "string", "example": "" }, "org_fixed_amount": { "type": "number", "example": 0 }, "org_percent": { "type": "number", "example": 0 }, "partner_id": { "type": "number", "example": 1 }, "plan_id": { "type": "number", "example": 154 }, "subsidy": { "type": "boolean", "example": false }, "trial": { "type": "boolean", "example": true }, "upcharge_fixed_amount": { "type": "number", "example": 0 }, "upcharge_percent": { "type": "number", "example": 0 }, "usage_quota": { "type": "number", "example": 0 } } }, "example": [ { "blueprint_job_fixed_amount": 0, "blueprint_job_percent": 0, "code": null, "days_to_live": 0, "expires_at": null, "hi_def_rendering_version_fixed_amount": 0, "hi_def_rendering_version_percent": 0, "hover_models_roof_estimate_fixed_amount": 0, "hover_models_roof_estimate_percent": 0, "id": 5085, "internal_description": null, "job_fixed_amount": 0, "job_percent": 0, "maximum_condition": null, "minimum_condition": null, "name": "", "org_fixed_amount": 0, "org_percent": 0, "partner_id": 1, "plan_id": 154, "subsidy": false, "trial": true, "upcharge_fixed_amount": 0, "upcharge_percent": 0, "usage_quota": 0 } ] }, "empty": { "type": "boolean", "example": false }, "external_partner_identifier": { "type": "string", "example": "" }, "features": { "type": "array", "items": { "type": "object", "properties": { "accessor_id": { "type": "number", "example": 154 }, "accessor_type": { "type": "string", "example": "Plan" }, "created_at": { "type": "string", "example": "2019-03-13T20:07:55.457Z" }, "deleted": { "type": "boolean", "example": false }, "deleted_at": { "nullable": true, "example": null }, "enabled": { "type": "boolean", "example": true }, "id": { "type": "number", "example": 12023 }, "identifier": { "type": "string", "example": "email_send_receipt" }, "updated_at": { "type": "string", "example": "2019-03-13T20:07:55.457Z" } } }, "example": [ { "accessor_id": 154, "accessor_type": "Plan", "created_at": "2019-03-13T20:07:55.457Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 12023, "identifier": "email_send_receipt", "updated_at": "2019-03-13T20:07:55.457Z" }, { "accessor_id": 154, "accessor_type": "Plan", "created_at": "2019-03-13T20:07:55.482Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 12024, "identifier": "hover_now", "updated_at": "2019-03-13T20:07:55.482Z" }, { "accessor_id": 154, "accessor_type": "Plan", "created_at": "2019-03-13T20:07:55.495Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 12025, "identifier": "prospect", "updated_at": "2019-03-13T20:07:55.495Z" }, { "accessor_id": 154, "accessor_type": "Plan", "created_at": "2019-03-13T20:07:55.506Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 12026, "identifier": "design_view_measurements_tool", "updated_at": "2019-03-13T20:07:55.506Z" }, { "accessor_id": 154, "accessor_type": "Plan", "created_at": "2019-03-13T21:55:15.435Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 12665, "identifier": "upgrade_to_pro", "updated_at": "2019-03-13T21:55:15.435Z" }, { "accessor_id": 154, "accessor_type": "Plan", "created_at": "2019-05-01T20:02:51.717Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 13849, "identifier": "team_management_advanced", "updated_at": "2019-05-01T20:02:51.717Z" }, { "accessor_id": 154, "accessor_type": "Plan", "created_at": "2022-09-16T20:32:45.574Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 51579, "identifier": "blueprints", "updated_at": "2022-09-16T20:32:45.574Z" }, { "accessor_id": 154, "accessor_type": "Plan", "created_at": "2023-05-05T19:53:47.494Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 113973, "identifier": "hi_def_rendering", "updated_at": "2023-05-05T19:53:47.494Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.901Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120638, "identifier": "export_advanced_job", "updated_at": "2023-07-25T20:28:06.901Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.905Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120639, "identifier": "measurements_files_access", "updated_at": "2023-07-25T20:28:06.905Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.908Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120640, "identifier": "integrations", "updated_at": "2023-07-25T20:28:06.908Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.911Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120641, "identifier": "ehi_project_management_product", "updated_at": "2023-07-25T20:28:06.911Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.915Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120642, "identifier": "export_esx", "updated_at": "2023-07-25T20:28:06.915Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.918Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120643, "identifier": "sequential_capture", "updated_at": "2023-07-25T20:28:06.918Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.921Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120644, "identifier": "out_of_the_box_material_lists", "updated_at": "2023-07-25T20:28:06.921Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.924Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120645, "identifier": "blueprints_commercial", "updated_at": "2023-07-25T20:28:06.924Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.927Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120646, "identifier": "blueprints_interior_job_type", "updated_at": "2023-07-25T20:28:06.927Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.929Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120647, "identifier": "inspection_checklist", "updated_at": "2023-07-25T20:28:06.929Z" } ] }, "id": { "type": "number", "example": 600530 }, "insurance": { "type": "boolean", "example": false }, "kind": { "type": "string", "example": "dealer" }, "label_ids": { "type": "array", "items": { "type": "number", "example": 1 }, "example": [ 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 ] }, "leaf": { "type": "boolean", "example": true }, "managed": { "type": "boolean", "example": false }, "manufacturer_ids": { "type": "array", "items": { "type": "number", "example": 56 }, "example": [ 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 ] }, "name": { "type": "string", "example": "Developer Docs Org" }, "needs_3d": { "type": "boolean", "example": true }, "own_wallet_is_billable": { "type": "boolean", "example": true }, "parent_id": { "type": "number", "example": 492855 }, "plan": { "type": "object", "properties": { "advanced_design": { "type": "boolean", "example": true }, "advanced_export": { "type": "boolean", "example": true }, "advanced_team_management": { "type": "boolean", "example": true }, "allow_multi_family_residential_captures": { "type": "boolean", "example": false }, "allow_photo_only_capture": { "type": "boolean", "example": true }, "allow_upgrade_to_pro": { "type": "boolean", "example": true }, "allows_instant_estimate": { "type": "boolean", "example": true }, "auto_assign_leads": { "type": "boolean", "example": false }, "basic_design": { "type": "boolean", "example": true }, "basic_export": { "type": "boolean", "example": true }, "basic_team_management": { "type": "boolean", "example": false }, "created_at": { "type": "string", "example": "2017-04-18T18:01:06.462Z" }, "days_of_historical_job_access": { "type": "number", "example": 0 }, "default": { "type": "boolean", "example": false }, "deleted": { "type": "boolean", "example": false }, "deleted_at": { "nullable": true, "example": null }, "description": { "type": "string", "example": "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" }, "email_receipt": { "type": "boolean", "example": true }, "feature_bullets": { "nullable": true, "example": null }, "feature_icons": { "nullable": true, "example": null }, "homeowner_lead_capture": { "type": "boolean", "example": false }, "id": { "type": "number", "example": 154 }, "machete": { "type": "boolean", "example": true }, "measurements": { "type": "boolean", "example": true }, "measurements_branding": { "type": "boolean", "example": false }, "metadata": { "type": "object", "properties": { "custom": { "type": "boolean", "example": false } } }, "name": { "type": "string", "example": "Pay As You Go" }, "ordering": { "type": "boolean", "example": false }, "org_analytics": { "type": "boolean", "example": false }, "partner": { "type": "object", "properties": { "allow_deliverable_choice": { "type": "boolean", "example": true }, "allow_insurance_damage_capture": { "type": "boolean", "example": false }, "allow_insurance_underwriting_capture": { "type": "boolean", "example": false }, "client_branding_logo_url": { "nullable": true, "example": null }, "deliverable_ids": { "type": "array", "items": { "type": "number", "example": 2 }, "example": [ 2, 3, 7 ] }, "id": { "type": "number", "example": 1 }, "identifier": { "type": "string", "example": "hover" }, "name": { "type": "string", "example": "Hover" } } }, "partner_analytics": { "type": "boolean", "example": false }, "partner_id": { "type": "number", "example": 1 }, "plan_after_trial_id": { "nullable": true, "example": null }, "sort_index": { "type": "number", "example": 1 }, "stripe_product_identifier": { "type": "string", "example": "prod_JapZ0j1ZdCf3cz" }, "synced_monthly_with_stripe": { "type": "boolean", "example": true }, "synced_yearly_with_stripe": { "type": "boolean", "example": true }, "tier": { "type": "string", "example": "basic" }, "updated_at": { "type": "string", "example": "2023-05-05T19:53:47.483Z" }, "visible": { "type": "boolean", "example": true } } }, "plan_billing_cycle": { "type": "string", "example": "monthly" }, "preferences": { "type": "object", "properties": { "created_at": { "type": "string", "example": "2023-07-25T20:20:50.257Z" }, "default_acl_template": { "type": "string", "example": "pro_plus" }, "deliverable_id": { "nullable": true, "example": null }, "external_identifier_label": { "type": "string", "example": "Lead Number" }, "external_identifier_required": { "type": "boolean", "example": false }, "external_identifier_strict_validation": { "type": "boolean", "example": false }, "id": { "type": "number", "example": 603634 }, "include_pro_user_name_in_invite_messages": { "type": "boolean", "example": true }, "ordering_email": { "type": "string", "example": "" }, "org_id": { "type": "number", "example": 600530 }, "preferred_roofing_waste_factor": { "nullable": true, "example": null }, "preferred_siding_waste_factor": { "nullable": true, "example": null }, "updated_at": { "type": "string", "example": "2023-07-25T20:28:06.958Z" } } }, "sales_rep": { "nullable": true, "example": null }, "settings": { "type": "object", "properties": { "allow_homeowner_order_renderings": { "type": "boolean", "example": false }, "allow_magic_link": { "type": "boolean", "example": false }, "allow_waste_factor_preference": { "nullable": true, "example": null }, "app_id": { "nullable": true, "example": null }, "app_name": { "nullable": true, "example": null }, "auto_accept_users": { "type": "boolean", "example": true }, "auto_approve_roof_estimate": { "type": "boolean", "example": false }, "auto_invoice_day": { "nullable": true, "example": null }, "auto_invoice_enabled": { "nullable": true, "example": null }, "capture_v2_enabled": { "type": "boolean", "example": true }, "commerce_product": { "type": "string", "example": "out_of_the_box_configuration" }, "config": { "type": "object", "properties": { "hidden_attributes": { "type": "object", "properties": { "Job": { "type": "object", "properties": { "name": { "type": "boolean", "example": false } } } } }, "job_priority_overrides": { "type": "object", "properties": { "expedite_roof_only": { "nullable": true, "example": null }, "homeowner_connect": { "nullable": true, "example": null }, "interior_homeowner_connect": { "nullable": true, "example": null } } }, "reconstruction": { "type": "object", "properties": { "vip_org": { "type": "boolean", "example": false } } } } }, "connect_message_template": { "nullable": true, "example": null }, "created_at": { "type": "string", "example": "2023-07-25T20:20:50.251Z" }, "customer_account": { "nullable": true, "example": null }, "example_jobs_identifier": { "nullable": true, "example": null }, "example_jobs_selection_method": { "type": "number", "example": 0 }, "example_jobs_support": { "type": "boolean", "example": false }, "exclude_capture_only": { "type": "boolean", "example": false }, "exclude_from_bulk_enable_manufacturer": { "type": "boolean", "example": false }, "hide_price_in_email": { "type": "boolean", "example": false }, "id": { "type": "number", "example": 600550 }, "interiors_priority": { "type": "number", "example": 12 }, "invoiced": { "type": "boolean", "example": false }, "locale": { "type": "string", "example": "en-US" }, "machete_features": { "type": "array", "items": { "type": "string", "example": "measurements" }, "example": [ "measurements", "share", "design" ] }, "model_price": { "type": "number", "example": 4995 }, "needs_3d": { "type": "boolean", "example": true }, "needs_texture": { "type": "boolean", "example": true }, "only_design_pro_for_capture_request": { "type": "boolean", "example": false }, "org_id": { "type": "number", "example": 600530 }, "payment_method": { "type": "string", "example": "credit_card" }, "pre_select_capture_only_for_users": { "type": "boolean", "example": false }, "prepaid_quota": { "type": "number", "example": 0 }, "priority": { "type": "number", "example": 12 }, "privacy_url": { "type": "string", "example": "/privacy" }, "send_renderings_nudge_email": { "type": "boolean", "example": false }, "show_design_studio": { "type": "boolean", "example": false }, "supports_co_branded_pro_measurements": { "type": "boolean", "example": false }, "supports_full_job_info_display": { "type": "boolean", "example": true }, "supports_leads": { "type": "boolean", "example": false }, "supports_machete": { "type": "boolean", "example": true }, "supports_openings_estimator": { "type": "boolean", "example": false }, "supports_openings_instant_estimator": { "type": "boolean", "example": false }, "supports_ordering": { "type": "boolean", "example": false }, "supports_redirect_to_new_website": { "type": "boolean", "example": true }, "supports_roof_measurements": { "type": "boolean", "example": true }, "supports_wall_measurements": { "type": "boolean", "example": true }, "terms_url": { "type": "string", "example": "/terms_of_use" }, "trial_enabled": { "type": "boolean", "example": true }, "trial_ends_at": { "nullable": true, "example": null }, "trial_expired": { "type": "boolean", "example": false }, "trial_period": { "type": "number", "example": 0 }, "trial_remaining_jobs_allowed": { "nullable": true, "example": null }, "trial_start": { "type": "string", "example": "2023-07-25T20:20:50.392Z" }, "updated_at": { "type": "string", "example": "2023-07-25T20:28:06.981Z" }, "vip": { "type": "boolean", "example": false } } }, "sort_order": { "nullable": true, "example": null }, "supports_openings": { "type": "boolean", "example": false }, "test_data": { "type": "boolean", "example": false }, "updated_at": { "type": "string", "example": "2023-07-25T20:28:07.766Z" }, "wallet": { "type": "object", "properties": { "balance": { "type": "number", "example": 0 }, "billing_address_city": { "nullable": true, "example": null }, "billing_address_country": { "nullable": true, "example": null }, "billing_address_line_1": { "nullable": true, "example": null }, "billing_address_line_2": { "nullable": true, "example": null }, "billing_address_postal_code": { "nullable": true, "example": null }, "billing_address_region": { "nullable": true, "example": null }, "billing_email": { "nullable": true, "example": null }, "card_brand": { "nullable": true, "example": null }, "card_expires_on": { "nullable": true, "example": null }, "card_last4": { "nullable": true, "example": null }, "cardholder_name": { "nullable": true, "example": null }, "created_at": { "type": "string", "example": "2023-07-25T20:20:50.380Z" }, "deleted": { "type": "boolean", "example": false }, "deleted_at": { "nullable": true, "example": null }, "id": { "type": "number", "example": 600442 }, "last_error": { "nullable": true, "example": null }, "org_id": { "type": "number", "example": 600530 }, "stripe_customer_identifier": { "nullable": true, "example": null }, "stripe_token": { "nullable": true, "example": null }, "updated_at": { "type": "string", "example": "2023-07-25T20:20:50.380Z" } } } } }, "updated_at": { "type": "string", "example": "2023-07-25T22:51:53.680Z" }, "user_id": { "type": "number", "example": 1537006 }, "user_name": { "type": "string", "example": "geoff.hull+devdocs@hoverinc.com" }, "via_job_share": { "nullable": true, "example": null }, "via_org_job_accesses": { "type": "array", "items": { "type": "object", "properties": { "archived": { "type": "boolean", "example": false }, "archived_at": { "nullable": true, "example": null }, "created_at": { "type": "string", "example": "2023-07-25T22:51:53.561Z" }, "id": { "type": "number", "example": 12565107 }, "job_id": { "type": "number", "example": 9824755 }, "kind": { "type": "string", "example": "creator" }, "lead_state": { "type": "string", "example": "assigned" }, "ordering_state": { "type": "string", "example": "lead" }, "org": { "type": "object", "properties": { "ancestral_name": { "type": "string", "example": "HOVER > Pro > Salesforce Package Development > Developer Docs Org" }, "customer_display_name": { "type": "string", "example": "Developer Docs Org" }, "id": { "type": "number", "example": 600530 }, "kind": { "type": "string", "example": "dealer" }, "model_price": { "type": "number", "example": 4995 }, "name": { "type": "string", "example": "Developer Docs Org" }, "ordering_email": { "type": "string", "example": "" }, "parent_id": { "type": "number", "example": 492855 }, "sort_order": { "nullable": true, "example": null }, "updated_at": { "type": "string", "example": "2023-07-25T20:28:07.766Z" } } }, "owner": { "type": "object", "properties": { "ancestral_name": { "type": "string", "example": "HOVER > Pro > Salesforce Package Development > Developer Docs Org" }, "customer_display_name": { "type": "string", "example": "Developer Docs Org" }, "id": { "type": "number", "example": 600530 }, "kind": { "type": "string", "example": "dealer" }, "model_price": { "type": "number", "example": 4995 }, "name": { "type": "string", "example": "Developer Docs Org" }, "ordering_email": { "type": "string", "example": "" }, "parent_id": { "type": "number", "example": 492855 }, "sort_order": { "nullable": true, "example": null }, "updated_at": { "type": "string", "example": "2023-07-25T20:28:07.766Z" } } }, "via_job_share": { "nullable": true, "example": null } } }, "example": [ { "archived": false, "archived_at": null, "created_at": "2023-07-25T22:51:53.561Z", "id": 12565107, "job_id": 9824755, "kind": "creator", "lead_state": "assigned", "ordering_state": "lead", "org": { "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "customer_display_name": "Developer Docs Org", "id": 600530, "kind": "dealer", "model_price": 4995, "name": "Developer Docs Org", "ordering_email": "", "parent_id": 492855, "sort_order": null, "updated_at": "2023-07-25T20:28:07.766Z" }, "owner": { "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "customer_display_name": "Developer Docs Org", "id": 600530, "kind": "dealer", "model_price": 4995, "name": "Developer Docs Org", "ordering_email": "", "parent_id": 492855, "sort_order": null, "updated_at": "2023-07-25T20:28:07.766Z" }, "via_job_share": null } ] }, "wallet": { "type": "object", "properties": { "id": { "type": "number", "example": 600442 }, "org": { "type": "object", "properties": { "customer_display_name": { "type": "string", "example": "Developer Docs Org" } } } } } } } } }, "examples": { "201 Created": { "value": { "job": { "additional_captured_jobs": [], "additional_information": null, "approved": true, "archived": false, "blueprint": false, "can_access_hi_def_rendering": true, "can_order_hi_def_rendering": true, "can_request_hi_def_rendering": true, "capture_request": null, "capture_session_identifier": null, "client_identifier": "521b9a3b-759b-49ea-9b1e-7632aec3f45a", "complete_expedited": false, "completed_at": null, "contractor_estimate_sent_to": null, "created_at": "2023-07-25T22:51:53.552Z", "customer_contact": null, "customer_contact_only_by_email": false, "customer_email": "homeowner@hover.to", "customer_first_name": null, "customer_name": "Michael Bluth", "customer_notes": null, "customer_phone": "5558675309", "deliverable_id": 3, "estimated_hours_to_completion": 0, "example": false, "external_identifier": "54965", "external_identifier_label": "Lead Number", "file_attachments": [], "hero_image": null, "id": 9824755, "job_assignments": [ { "archived": false, "archived_at": null, "assigned_by": null, "created_at": "2023-07-25T22:51:53.577Z", "id": 14905200, "job_id": 9824755, "kind": "creator", "org": { "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "customer_display_name": "Developer Docs Org", "id": 600530, "kind": "dealer", "model_price": 4995, "name": "Developer Docs Org", "ordering_email": "", "parent_id": 492855, "sort_order": null, "updated_at": "2023-07-25T20:28:07.766Z" }, "updated_at": "2023-07-25T22:51:53.577Z", "user": { "aasm_state": "activated", "email": "geoff.hull+devdocs@hoverinc.com", "first_name": "Geoff", "id": 1537006, "last_name": "Hull", "preferred_identifier": null, "require_job_approval": false, "sign_in_count": 0, "time_zone": "Pacific Time (US & Canada)" }, "user_id": 1537006 } ], "job_shares": [], "location": { "city": "Los Angeles", "country": "US", "line_1": "123 HOVER Way", "line_2": "", "postal_code": "90210", "region": "CA" }, "location_city": "Los Angeles", "location_country": "US", "location_lat": null, "location_line_1": "123 HOVER Way", "location_line_2": "", "location_lon": null, "location_postal_code": "90210", "location_region": "CA", "machete_blob": { "DesignFeature": { "labelsSrc": "https://hover.to/hover_models/labels.json", "manufacturerProductsSrc": "https://products.hover.to/hover_models/manufacturer_products.json", "manufacturersSrc": "https://products.hover.to/hover_models/manufacturers.json?provider_ids%5B%5D=56&provider_ids%5B%5D=57&provider_ids%5B%5D=58&provider_ids%5B%5D=59&provider_ids%5B%5D=91&provider_ids%5B%5D=1&provider_ids%5B%5D=2&provider_ids%5B%5D=6&provider_ids%5B%5D=7&provider_ids%5B%5D=3&provider_ids%5B%5D=9&provider_ids%5B%5D=11&provider_ids%5B%5D=5&provider_ids%5B%5D=12&provider_ids%5B%5D=14&provider_ids%5B%5D=15&provider_ids%5B%5D=16&provider_ids%5B%5D=17&provider_ids%5B%5D=18&provider_ids%5B%5D=225&provider_ids%5B%5D=54&provider_ids%5B%5D=4&provider_ids%5B%5D=371&provider_ids%5B%5D=52&provider_ids%5B%5D=389&provider_ids%5B%5D=424&provider_ids%5B%5D=1745&provider_ids%5B%5D=1749&provider_ids%5B%5D=8&provider_ids%5B%5D=1756&provider_ids%5B%5D=1201&provider_ids%5B%5D=8485&provider_ids%5B%5D=5839&provider_ids%5B%5D=8532&provider_ids%5B%5D=8502", "productsSrc": "https://products.hover.to/hover_models/products.json", "showWindowColors": false }, "DesignPro": { "usePBRMode": false }, "InfoFeature": { "address": "123 HOVER Way", "username": "HOVER" }, "MeasurementsFeature": { "includeOpenings": true, "includePremiumMeasurements": true, "includeProMeasurements": true, "includeRoof": true, "includeSurfaceAreas": true, "includeWalls": true, "labelsSrc": "https://hover.to/hover_models/labels.json", "measurementsSrc": "https://hover.to/api/v1/models/9822327/machete_model_measurements", "useMetricSystem": false }, "OptInFeature": { "designProUrl": "https://hover.to/3d/9824755", "enabled": true }, "PlanetTerror": { "manufacturerProductsSrc": "https://products.hover.to/hover_models/manufacturer_products.json", "manufacturersSrc": "https://products.hover.to/hover_models/manufacturers.json?provider_ids%5B%5D=56&provider_ids%5B%5D=57&provider_ids%5B%5D=58&provider_ids%5B%5D=59&provider_ids%5B%5D=91&provider_ids%5B%5D=1&provider_ids%5B%5D=2&provider_ids%5B%5D=6&provider_ids%5B%5D=7&provider_ids%5B%5D=3&provider_ids%5B%5D=9&provider_ids%5B%5D=11&provider_ids%5B%5D=5&provider_ids%5B%5D=12&provider_ids%5B%5D=14&provider_ids%5B%5D=15&provider_ids%5B%5D=16&provider_ids%5B%5D=17&provider_ids%5B%5D=18&provider_ids%5B%5D=225&provider_ids%5B%5D=54&provider_ids%5B%5D=4&provider_ids%5B%5D=371&provider_ids%5B%5D=52&provider_ids%5B%5D=389&provider_ids%5B%5D=424&provider_ids%5B%5D=1745&provider_ids%5B%5D=1749&provider_ids%5B%5D=8&provider_ids%5B%5D=1756&provider_ids%5B%5D=1201&provider_ids%5B%5D=8485&provider_ids%5B%5D=5839&provider_ids%5B%5D=8532&provider_ids%5B%5D=8502", "productsSrc": "https://products.hover.to/hover_models/products.json" }, "ShareFeature": {}, "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", "useDesignFeature": true, "useDesignPro": true, "useInfoFeature": true, "useLabsFeature": false, "useMeasurementsFeature": true, "useOptInFeature": true, "useShareFeature": true }, "machete_features": [ "ShareFeature", "MeasurementsFeature", "DesignFeature" ], "models": [ { "address": null, "archive_number": null, "archived": false, "archived_at": null, "atlas": null, "cameras": {}, "complexity_attributes": null, "complexity_score": "large", "created_at": "2023-07-25T22:51:53.601Z", "created_with_job": true, "cv_data": {}, "dense_capture": null, "export": null, "failure_reason": null, "footprint_to_a": [], "id": 9822327, "image_archive": { "cloudfront_upload_url": "https://hover.to/Hyperion/Model/9822327/image_archive.zip?response-content-type=application%2Foctet-stream&Expires=1690671113&Signature=CzuHdJWtG9OG2w1Tq1oa7NnQGsVy3MAJ4klSnjtnJ86cCvO55etKejEsuZm~Qdx9~zJihJUebIUA6C-517i-iwgivI8aZaBRbnhaRy1NjdlAIjeb7S6WjmaDMC-7rSgRhzYjDqOFgkGrq2~8QVK7BxHYY75WbhSWc9A-BX8XxyuvXzMy1pcNgiBaNFV63scWt5DRFMuV1bKrYKcVxwPKpkZpQSZpqsW588PGau1aAyLy-4pIi--5QImWAjUKbyKZiSoqultlUZeTBz4s2FDwpEIRlLSXr6Yq55ZBxoWHI87tkR5BGokXzyRjYiS9LyPwyhFTpIFYU~OyHVM2gv6foA__&Key-Pair-Id=APKAJOCSUB5UYQFW7A5Q", "high_res": { "cloudfront_upload_url": "https://hover.to/Hyperion/Model/9822327/image_archive_high_res.zip?response-content-type=application%2Foctet-stream&Expires=1690671113&Signature=HO6B1CQrA30qCAwiU27nf-H7rX9Q4hNZhsE8H00-~o6PSh4SvCp5lKz87E74w2WzSomh8B8uzN0jKBOOKhROm6KGURS7E6SVycYaN58s7fm42hd2ogeSYPMUovNzoauzPzAG43iuBLMvpIX4MKxjSiLYl5M40OAHVvD3OfEXtJCdvYaiyPw97lOdAf2m7nBg2SDENXQ1CPPNxganQVvX8uu3lyxKy53gqnWvLGi~7mjUHj6qxT9hfnuCtd9hH8AZRKCjkho6SoYSqigX7e-1Su~IsScaHJ9m4VRXnKTRya-~l19Opfu4PMdFtv1L5TjyWZCiGje~GVDz~mZqVaCbrA__&Key-Pair-Id=APKAJOCSUB5UYQFW7A5Q", "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%2F20230725%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230725T225153Z&X-Amz-Expires=345600&X-Amz-SignedHeaders=host&X-Amz-Signature=279ddcfc3625c53e623c2114f70fb0f598f82d67f8042f179640dc9c35e366bf" }, "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%2F20230725%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20230725T225153Z&X-Amz-Expires=345600&X-Amz-SignedHeaders=host&X-Amz-Signature=0667873ea91eb56767bd2c1a95848f491cda8e59bd85c65235aa93d7b9c52ec5" }, "images": [], "important_changed_areas_to_notify_user_about": null, "interior_floor_plan_measurements": null, "is_3d_available": false, "job_id": 9824755, "machete": null, "machete_model_measurements": {}, "manowar_identifier": null, "manually_uploaded_by_id": null, "measurement_results_s3_key": null, "message_to_production_team": null, "model_json_v3": null, "modeling_status": null, "original_model_id": null, "payment_method": "free", "polygon": null, "position_wgs": [], "pro_measurements": null, "pro_premium_measurements": null, "reprocessed": false, "roof_measurements": null, "siding_report": null, "state": "uploading", "structured_mesh": {}, "token": null, "total_living_area_measurements": null, "total_living_area_plus_measurements": null, "tracking_log": {}, "unstructured_mesh": {}, "updated_at": "2023-07-25T22:51:53.612Z", "video": null, "wireframe_back": {}, "wireframe_back_left": {}, "wireframe_footprint": {}, "wireframe_front": {}, "wireframe_front_right": {}, "wireframe_left": {}, "wireframe_left_front": {}, "wireframe_right": {}, "wireframe_right_back": {}, "wireframe_roof": {}, "wireframe_total_living_area": {} } ], "name": "Bluth Development House 1", "org_id": 600530, "org_job_accesses": [ { "archived": false, "archived_at": null, "created_at": "2023-07-25T22:51:53.561Z", "id": 12565107, "job_id": 9824755, "kind": "creator", "lead_state": "assigned", "ordering_state": "lead", "org": { "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "customer_display_name": "Developer Docs Org", "id": 600530, "kind": "dealer", "model_price": 4995, "name": "Developer Docs Org", "ordering_email": "", "parent_id": 492855, "sort_order": null, "updated_at": "2023-07-25T20:28:07.766Z" }, "owner": { "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "customer_display_name": "Developer Docs Org", "id": 600530, "kind": "dealer", "model_price": 4995, "name": "Developer Docs Org", "ordering_email": "", "parent_id": 492855, "sort_order": null, "updated_at": "2023-07-25T20:28:07.766Z" }, "via_job_share": null } ], "org_name": "Developer Docs Org", "orgs": [ { "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "customer_display_name": "Developer Docs Org", "id": 600530, "kind": "dealer", "model_price": 4995, "name": "Developer Docs Org", "ordering_email": "", "parent_id": 492855, "sort_order": null, "updated_at": "2023-07-25T20:28:07.766Z" } ], "pending_capture_request": null, "property_type": "single_family_residential", "roof_estimate": null, "roof_estimate_access_level": "instant", "roof_estimate_presold": false, "roof_estimate_purchase_state": null, "roof_estimate_supported": true, "shared": false, "state": "uploading", "suppress_email": null, "symbility_xml_url": null, "through_org": { "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "available_deliverable_ids": [ 2, 3, 7 ], "billable_wallets": [], "brand": { "email_logo": { "url": "https://hover.to/api/v1/orgs/39/brand/email_logo.png" }, "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 }, "id": 65, "logo": { "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" }, "thumb": { "url": "https://hover.to/api/v1/orgs/39/brand/logo.png?version=thumb" }, "url": "https://hover.to/api/v1/orgs/39/brand/logo.png" }, "model_background_color": { "b": 213, "g": 148, "r": 8 }, "model_terrain_color": { "b": 102, "g": 153, "r": 102 }, "org_id": 39, "places_logo": { "url": "https://hover.to/api/v1/orgs/39/brand/places_logo.png" }, "primary_color": { "b": 220, "g": 125, "r": 36 }, "secondary_color": { "b": 220, "g": 125, "r": 36 }, "tertiary_color": { "b": 220, "g": 125, "r": 36 } }, "client_branding_logo_url": null, "created_at": "2023-07-25T20:20:50.240Z", "cust_serv_city": null, "cust_serv_contact": null, "cust_serv_line_1": null, "cust_serv_line_2": null, "cust_serv_name": null, "cust_serv_phone": null, "cust_serv_postal_code": null, "cust_serv_region": null, "customer_display_name": "Developer Docs Org", "deliverable_id": null, "deliverable_ids": [ 2, 3, 7 ], "discounts": [ { "blueprint_job_fixed_amount": 0, "blueprint_job_percent": 0, "code": null, "days_to_live": 0, "expires_at": null, "hi_def_rendering_version_fixed_amount": 0, "hi_def_rendering_version_percent": 0, "hover_models_roof_estimate_fixed_amount": 0, "hover_models_roof_estimate_percent": 0, "id": 5085, "internal_description": null, "job_fixed_amount": 0, "job_percent": 0, "maximum_condition": null, "minimum_condition": null, "name": "", "org_fixed_amount": 0, "org_percent": 0, "partner_id": 1, "plan_id": 154, "subsidy": false, "trial": true, "upcharge_fixed_amount": 0, "upcharge_percent": 0, "usage_quota": 0 } ], "empty": false, "external_partner_identifier": "", "features": [ { "accessor_id": 154, "accessor_type": "Plan", "created_at": "2019-03-13T20:07:55.457Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 12023, "identifier": "email_send_receipt", "updated_at": "2019-03-13T20:07:55.457Z" }, { "accessor_id": 154, "accessor_type": "Plan", "created_at": "2019-03-13T20:07:55.482Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 12024, "identifier": "hover_now", "updated_at": "2019-03-13T20:07:55.482Z" }, { "accessor_id": 154, "accessor_type": "Plan", "created_at": "2019-03-13T20:07:55.495Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 12025, "identifier": "prospect", "updated_at": "2019-03-13T20:07:55.495Z" }, { "accessor_id": 154, "accessor_type": "Plan", "created_at": "2019-03-13T20:07:55.506Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 12026, "identifier": "design_view_measurements_tool", "updated_at": "2019-03-13T20:07:55.506Z" }, { "accessor_id": 154, "accessor_type": "Plan", "created_at": "2019-03-13T21:55:15.435Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 12665, "identifier": "upgrade_to_pro", "updated_at": "2019-03-13T21:55:15.435Z" }, { "accessor_id": 154, "accessor_type": "Plan", "created_at": "2019-05-01T20:02:51.717Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 13849, "identifier": "team_management_advanced", "updated_at": "2019-05-01T20:02:51.717Z" }, { "accessor_id": 154, "accessor_type": "Plan", "created_at": "2022-09-16T20:32:45.574Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 51579, "identifier": "blueprints", "updated_at": "2022-09-16T20:32:45.574Z" }, { "accessor_id": 154, "accessor_type": "Plan", "created_at": "2023-05-05T19:53:47.494Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 113973, "identifier": "hi_def_rendering", "updated_at": "2023-05-05T19:53:47.494Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.901Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120638, "identifier": "export_advanced_job", "updated_at": "2023-07-25T20:28:06.901Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.905Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120639, "identifier": "measurements_files_access", "updated_at": "2023-07-25T20:28:06.905Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.908Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120640, "identifier": "integrations", "updated_at": "2023-07-25T20:28:06.908Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.911Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120641, "identifier": "ehi_project_management_product", "updated_at": "2023-07-25T20:28:06.911Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.915Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120642, "identifier": "export_esx", "updated_at": "2023-07-25T20:28:06.915Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.918Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120643, "identifier": "sequential_capture", "updated_at": "2023-07-25T20:28:06.918Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.921Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120644, "identifier": "out_of_the_box_material_lists", "updated_at": "2023-07-25T20:28:06.921Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.924Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120645, "identifier": "blueprints_commercial", "updated_at": "2023-07-25T20:28:06.924Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.927Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120646, "identifier": "blueprints_interior_job_type", "updated_at": "2023-07-25T20:28:06.927Z" }, { "accessor_id": 600530, "accessor_type": "Org", "created_at": "2023-07-25T20:28:06.929Z", "deleted": false, "deleted_at": null, "enabled": true, "id": 120647, "identifier": "inspection_checklist", "updated_at": "2023-07-25T20:28:06.929Z" } ], "id": 600530, "insurance": false, "kind": "dealer", "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 ], "leaf": true, "managed": false, "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 ], "name": "Developer Docs Org", "needs_3d": true, "own_wallet_is_billable": true, "parent_id": 492855, "plan": { "advanced_design": true, "advanced_export": true, "advanced_team_management": true, "allow_multi_family_residential_captures": false, "allow_photo_only_capture": true, "allow_upgrade_to_pro": true, "allows_instant_estimate": true, "auto_assign_leads": false, "basic_design": true, "basic_export": true, "basic_team_management": false, "created_at": "2017-04-18T18:01:06.462Z", "days_of_historical_job_access": 0, "default": false, "deleted": false, "deleted_at": null, "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", "email_receipt": true, "feature_bullets": null, "feature_icons": null, "homeowner_lead_capture": false, "id": 154, "machete": true, "measurements": true, "measurements_branding": false, "metadata": { "custom": false }, "name": "Pay As You Go", "ordering": false, "org_analytics": false, "partner": { "allow_deliverable_choice": true, "allow_insurance_damage_capture": false, "allow_insurance_underwriting_capture": false, "client_branding_logo_url": null, "deliverable_ids": [ 2, 3, 7 ], "id": 1, "identifier": "hover", "name": "Hover" }, "partner_analytics": false, "partner_id": 1, "plan_after_trial_id": null, "sort_index": 1, "stripe_product_identifier": "prod_JapZ0j1ZdCf3cz", "synced_monthly_with_stripe": true, "synced_yearly_with_stripe": true, "tier": "basic", "updated_at": "2023-05-05T19:53:47.483Z", "visible": true }, "plan_billing_cycle": "monthly", "preferences": { "created_at": "2023-07-25T20:20:50.257Z", "default_acl_template": "pro_plus", "deliverable_id": null, "external_identifier_label": "Lead Number", "external_identifier_required": false, "external_identifier_strict_validation": false, "id": 603634, "include_pro_user_name_in_invite_messages": true, "ordering_email": "", "org_id": 600530, "preferred_roofing_waste_factor": null, "preferred_siding_waste_factor": null, "updated_at": "2023-07-25T20:28:06.958Z" }, "sales_rep": null, "settings": { "allow_homeowner_order_renderings": false, "allow_magic_link": false, "allow_waste_factor_preference": null, "app_id": null, "app_name": null, "auto_accept_users": true, "auto_approve_roof_estimate": false, "auto_invoice_day": null, "auto_invoice_enabled": null, "capture_v2_enabled": true, "commerce_product": "out_of_the_box_configuration", "config": { "hidden_attributes": { "Job": { "name": false } }, "job_priority_overrides": { "expedite_roof_only": null, "homeowner_connect": null, "interior_homeowner_connect": null }, "reconstruction": { "vip_org": false } }, "connect_message_template": null, "created_at": "2023-07-25T20:20:50.251Z", "customer_account": null, "example_jobs_identifier": null, "example_jobs_selection_method": 0, "example_jobs_support": false, "exclude_capture_only": false, "exclude_from_bulk_enable_manufacturer": false, "hide_price_in_email": false, "id": 600550, "interiors_priority": 12, "invoiced": false, "locale": "en-US", "machete_features": [ "measurements", "share", "design" ], "model_price": 4995, "needs_3d": true, "needs_texture": true, "only_design_pro_for_capture_request": false, "org_id": 600530, "payment_method": "credit_card", "pre_select_capture_only_for_users": false, "prepaid_quota": 0, "priority": 12, "privacy_url": "/privacy", "send_renderings_nudge_email": false, "show_design_studio": false, "supports_co_branded_pro_measurements": false, "supports_full_job_info_display": true, "supports_leads": false, "supports_machete": true, "supports_openings_estimator": false, "supports_openings_instant_estimator": false, "supports_ordering": false, "supports_redirect_to_new_website": true, "supports_roof_measurements": true, "supports_wall_measurements": true, "terms_url": "/terms_of_use", "trial_enabled": true, "trial_ends_at": null, "trial_expired": false, "trial_period": 0, "trial_remaining_jobs_allowed": null, "trial_start": "2023-07-25T20:20:50.392Z", "updated_at": "2023-07-25T20:28:06.981Z", "vip": false }, "sort_order": null, "supports_openings": false, "test_data": false, "updated_at": "2023-07-25T20:28:07.766Z", "wallet": { "balance": 0, "billing_address_city": null, "billing_address_country": null, "billing_address_line_1": null, "billing_address_line_2": null, "billing_address_postal_code": null, "billing_address_region": null, "billing_email": null, "card_brand": null, "card_expires_on": null, "card_last4": null, "cardholder_name": null, "created_at": "2023-07-25T20:20:50.380Z", "deleted": false, "deleted_at": null, "id": 600442, "last_error": null, "org_id": 600530, "stripe_customer_identifier": null, "stripe_token": null, "updated_at": "2023-07-25T20:20:50.380Z" } }, "updated_at": "2023-07-25T22:51:53.680Z", "user_id": 1537006, "user_name": "geoff.hull+devdocs@hoverinc.com", "via_job_share": null, "via_org_job_accesses": [ { "archived": false, "archived_at": null, "created_at": "2023-07-25T22:51:53.561Z", "id": 12565107, "job_id": 9824755, "kind": "creator", "lead_state": "assigned", "ordering_state": "lead", "org": { "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "customer_display_name": "Developer Docs Org", "id": 600530, "kind": "dealer", "model_price": 4995, "name": "Developer Docs Org", "ordering_email": "", "parent_id": 492855, "sort_order": null, "updated_at": "2023-07-25T20:28:07.766Z" }, "owner": { "ancestral_name": "HOVER > Pro > Salesforce Package Development > Developer Docs Org", "customer_display_name": "Developer Docs Org", "id": 600530, "kind": "dealer", "model_price": 4995, "name": "Developer Docs Org", "ordering_email": "", "parent_id": 492855, "sort_order": null, "updated_at": "2023-07-25T20:28:07.766Z" }, "via_job_share": null } ], "wallet": { "id": 600442, "org": { "customer_display_name": "Developer Docs Org" } } } } } } } } }, "422": { "description": "422 Unprocessable Entity", "headers": { "Alt-Svc": { "schema": { "type": "string", "example": "h3=\":443\"; ma=86400" } }, "CF-Cache-Status": { "schema": { "type": "string", "example": "DYNAMIC" } }, "CF-Ray": { "schema": { "type": "string", "example": "7ec7f8c808099452-SJC" } }, "Cache-Control": { "schema": { "type": "string", "example": "no-cache" } }, "Connection": { "schema": { "type": "string", "example": "keep-alive" } }, "Date": { "schema": { "type": "string", "example": "Tue, 25 Jul 2023 22:52:11 GMT" } }, "Referrer-Policy": { "schema": { "type": "string", "example": "strict-origin-when-cross-origin" } }, "Server": { "schema": { "type": "string", "example": "cloudflare" } }, "Set-Cookie": { "schema": { "type": "string", "example": "_hyperion_session=ecfea63a3fec9c30625550e4c86ba741; domain=.hover.to; path=/; expires=Thu, 24 Aug 2023 22:52:10 GMT; secure; HttpOnly; SameSite=Lax" } }, "Strict-Transport-Security": { "schema": { "type": "string", "example": "max-age=0" } }, "Transfer-Encoding": { "schema": { "type": "string", "example": "chunked" } }, "Vary": { "schema": { "type": "string", "example": "Origin, Accept-Encoding" } }, "Via": { "schema": { "type": "string", "example": "1.1 google" } }, "X-Content-Type-Options": { "schema": { "type": "string", "example": "nosniff" } }, "X-Download-Options": { "schema": { "type": "string", "example": "noopen" } }, "X-Frame-Options": { "schema": { "type": "string", "example": "ALLOWALL" } }, "X-Permitted-Cross-Domain-Policies": { "schema": { "type": "string", "example": "none" } }, "X-Request-Id": { "schema": { "type": "string", "example": "c26abd35-c480-4d51-8974-ca290717712b" } }, "X-Runtime": { "schema": { "type": "string", "example": "0.022942" } }, "X-XSS-Protection": { "schema": { "type": "string", "example": "0" } } }, "content": { "application/json": { "schema": { "type": "object", "properties": { "error": { "type": "string", "example": "The `current_user_email` or `current_user_id` parameter is required when authenticated via OAuth" } } }, "examples": { "422 Unprocessable Entity": { "value": { "error": "The `current_user_email` or `current_user_id` parameter is required when authenticated via OAuth" } } } } } } } } } }, "components": { "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer" } } }, "security": [ { "bearerAuth": [] } ], "tags": [ { "name": "Jobs" } ], "x-readme": { "explorer-enabled": true, "proxy-enabled": true } } ````