### FML Export Example Source: https://developers.hover.to/reference/get-fml-export This section provides an example of the JSON structure for exporting floor plan data, including details about floors, designs, areas, walls, and items. ```APIDOC ## GET /websites/developers_hover_to_reference/export ### Description Retrieves the FML (Floor Plan Markup Language) export example for developer reference. This endpoint demonstrates the structure of floor plan data. ### Method GET ### Endpoint /websites/developers_hover_to_reference/export ### Parameters None ### Request Example None ### Response #### Success Response (200) - **floors** (array) - An array of floor objects, each containing id, name, level, height, and designs. - **designs** (array) - An array of design objects, each containing name, areas, and walls. - **areas** (array) - An array of area objects, each containing name and a polygon representation. - **poly** (array) - An array of points defining the area's boundary. - **walls** (array) - An array of wall objects, each containing start and end points (a, b), z-axis information (az, bz), thickness, balance, and openings. - **a** (object) - The starting point of the wall with x and y coordinates. - **b** (object) - The ending point of the wall with x and y coordinates. - **az** (object) - Z-axis information for point 'a', including z and h (height). - **bz** (object) - Z-axis information for point 'b', including z and h (height). - **openings** (array) - An array of openings (doors or windows) within the wall. - **refid** (string) - Reference ID for the opening. - **t** (number) - Type or position indicator for the opening. - **type** (string) - The type of opening (e.g., "door", "window"). - **width** (number) - The width of the opening. - **z_height** (number) - The height of the opening in the z-axis. - **z** (number) - The z-coordinate of the opening. - **mirrored** (array) - Mirroring information for the opening. - **items** (array) - An array of item objects placed within a design, each containing name and position (x, y, z). #### Response Example ```json { "floors": [ { "id": 1, "name": "Floor Plan", "level": 0, "height": 0, "designs": [ { "name": "Default Design", "areas": [ { "name": "Bedroom", "poly": [ { "x": -168.37804780000002, "y": -170.9180478 }, { "x": -168.37804780000002, "y": -168.37804780000002 }, { "x": -170.9180478, "y": -168.37804780000002 }, { "x": -170.9180478, "y": -170.9180478 } ] } ], "walls": [ { "a": { "x": -450.31586340000007, "y": 5.08 }, "b": { "x": -450.31586340000007, "y": -223.24799140000002 }, "az": { "z": 0, "h": 246.50000100000003 }, "bz": { "z": 0, "h": 246.50000100000003 }, "thickness": 10.15999999999999, "balance": 0.5, "openings": [] } ], "items": [ { "name": "C-1", "x": -416.7371240556969, "y": -159.59813140000009, "z": 0 } ] } ] } ] } ``` ``` -------------------------------- ### List Organization Tree API Request Examples Source: https://developers.hover.to/reference/organizations This snippet demonstrates how to make a GET request to the List Organization Tree API endpoint. It shows the cURL command and provides equivalent examples in Shell, Node.js, Ruby, PHP, and Python. The endpoint requires an 'accept' header set to 'application/json'. ```shell curl --request GET \ --url https://hover.to/api/v2/orgs/administered \ --header 'accept: application/json' ``` ```node const options = { method: 'GET', headers: { 'accept': 'application/json' } }; fetch('https://hover.to/api/v2/orgs/administered', options) .then(response => response.json()) .then(response => console.log(response)) .catch(error => console.error(error)); ``` ```ruby require 'uri' require 'net/http' url = URI("https://hover.to/api/v2/orgs/administered") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["accept"] = "application/json" response = http.request(request) puts response.read_body ``` ```php ``` ```python import requests url = "https://hover.to/api/v2/orgs/administered" headers = { "accept": "application/json" } response = requests.get(url, headers=headers) data = response.json() print(data) ``` -------------------------------- ### Configuration Settings in JavaScript Source: https://developers.hover.to/reference/createajob This snippet shows example JavaScript object notation for configuring various settings within the Hover platform. It includes options related to invoicing, pricing visibility, capture requests, user permissions, and localization. These settings control the behavior and appearance of features for different user roles and scenarios. ```javascript { "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 } ``` -------------------------------- ### Website Developers API - Example Resource Data Source: https://developers.hover.to/reference/createajob This snippet shows an example of resource data associated with a website developer, including details like IDs, creation timestamps, and identifiers. ```APIDOC ## GET /websites/developers/{id}/resources ### Description Retrieves a list of resources associated with a specific website developer. ### Method GET ### Endpoint `/websites/developers/{id}/resources` ### Parameters #### Path Parameters - **id** (number) - Required - The unique identifier of the website developer. #### Query Parameters None #### Request Body None ### Request Example ```bash GET /websites/developers/600530/resources ``` ### Response #### Success Response (200) - **resources** (array) - A list of resource objects. - **accessor_id** (number) - The ID of the accessor. - **accessor_type** (string) - The type of the accessor (e.g., 'Org'). - **created_at** (string) - The timestamp when the resource was created. - **deleted** (boolean) - Indicates if the resource is deleted. - **deleted_at** (null) - The timestamp when the resource was deleted (null if not deleted). - **enabled** (boolean) - Indicates if the resource is enabled. - **id** (number) - The unique identifier of the resource. - **identifier** (string) - A unique identifier for the resource (e.g., 'out_of_the_box_material_lists'). - **updated_at** (string) - The timestamp when the resource was last updated. #### Response Example ```json { "resources": [ { "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" } ] } ``` ``` -------------------------------- ### GET /websites/developers_hover_to_reference Source: https://developers.hover.to/reference/getinspectiondetails Retrieves details about a specific developer project, including its associated inspection data and photos. ```APIDOC ## GET /websites/developers_hover_to_reference ### Description This endpoint retrieves detailed information about a developer project, including its title, type, state, and submission timestamp. It also includes nested data for the `job` and `inspector`, as well as a list of `photo_captures` with their associated images. ### Method GET ### Endpoint `/websites/developers_hover_to_reference` ### Parameters This endpoint does not have any explicit path, query, or request body parameters documented in the provided text. ### Request Example ```json { "example": "No request example available for GET" } ``` ### Response #### Success Response (200) - **id** (number) - The unique identifier for the project. - **inspector** (object) - Information about the inspector. - **id** (number) - The inspector's unique identifier. - **name** (string) - The inspector's name. - **job** (object) - Information about the job associated with the project. - **city** (string) - The city where the job is located (can be null). - **photo_captures** (array) - A list of photo capture objects associated with the project. - **captured_photos** (array) - A list of captured photo objects within a capture. - **answers** (array) - Answers associated with a photo. - **tags** (array) - Tags associated with a photo. - **urls** (object) - URLs for different representations of the captured photo. - **original** (string) - URL for the original photo. - **w1152** (string) - URL for the photo resized to 1152px width. - **w1440** (string) - URL for the photo resized to 1440px width. - **w480** (string) - URL for the photo resized to 480px width. - **w834** (string) - URL for the photo resized to 834px width. - **description** (string) - Description of the photo capture. - **kind** (string) - The type of photo capture (e.g., "photo_capture"). - **name** (string) - The name of the photo capture (e.g., "Starter Strip"). - **sort_order** (number) - The order in which this capture should be sorted. - **state** (string) - The current state of the project (e.g., "submitted"). - **submitted_at** (string) - The timestamp when the project was submitted (ISO 8601 format). - **title** (string) - The title of the project. - **total_photos** (number) - The total number of photos associated with the project. - **type** (string) - The type of the project (e.g., "damage"). #### Response Example ```json { "id": 3066, "inspector": { "id": 1417143, "name": "Michael Bluth" }, "job": { "city": null }, "photo_captures": [ { "captured_photos": [], "description": "", "kind": "photo_capture", "name": "Starter Strip", "sort_order": 5 }, { "captured_photos": [], "description": "", "kind": "photo_capture", "name": "Rake Drip Edge", "sort_order": 6 }, { "captured_photos": [ { "answers": [], "tags": [], "urls": { "original": "https://hover.to/rails/active_storage/blobs/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NzI1NTYxOTEsInB1ciI6ImJsb2JfaWQifX0=--96afeaf31b5c3d260b50902f912ce3cb9bc4b67e/8b4e62fa-36f5-43d9-905a-f199640a5a1d.jpg.jpg", "w1152": "https://hover.to/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NzI1NTYxOTEsInB1ciI6ImJsb2JfaWQifX0=--96afeaf31b5c3d260b50902f912ce3cb9bc4b67e/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJ3ZWJwIiwicmVzaXplX3RvX2xpbWl0IjpbMTE1MixudWxsXSwic2F2ZXIiOnsicXVhbGl0eSI6NDB9LCJjb252ZXJ0Ijoid2VicCJ9LCJwdXIiOiJ2YXJpYXRpb24ifX0=--f02557be3a6af3a68f3a0d75b10d8c68c8f37d3f/8b4e62fa-36f5-43d9-905a-f199640a5a1d.jpg.webp", "w1440": "https://hover.to/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NzI1NTYxOTEsInB1ciI6ImJsb2JfaWQifX0=--96afeaf31b5c3d260b50902f912ce3cb9bc4b67e/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJ3ZWJwIiwicmVzaXplX3RvX2xpbWl0IjpbMTQ0MCxudWxsXSwic2F2ZXIiOnsicXVhbGl0eSI6NDB9LCJjb252ZXJ0Ijoid2VicCJ9LCJwdXIiOiJ2YXJpYXRpb24ifX0=--e4cd227cdf1694d0f332d524f97e9dce63ef9994/8b4e62fa-36f5-43d9-905a-f199640a5a1d.jpg.webp", "w480": "https://hover.to/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NzI1NTYxOTEsInB1ciI6ImJsb2JfaWQifX0=--96afeaf31b5c3d260b50902f912ce3cb9bc4b67e/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJ3ZWJwIiwicmVzaXplX3RvX2xpbWl0IjpbNDgwLG51bGxdLCJzYXZlciI6eyJxdWFsaXR5Ijo0MH0sImNvbnZlcnQiOiJ3ZWJwIn0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--3443864ee69eccecc24873d2859402ba99580fc5/8b4e62fa-36f5-43d9-905a-f199640a5a1d.jpg.webp", "w834": "https://hover.to/rails/active_storage/representations/proxy/eyJfcmFpbHMiOnsiZGF0YSI6NzI1NTYxOTEsInB1ciI6ImJsb2JfaWQifX0=--96afeaf31b5c3d260b50902f912ce3cb9bc4b67e/eyJfcmFpbHMiOnsiZGF0YSI6eyJmb3JtYXQiOiJ3ZWJwIiwicmVzaXplX3RvX2xpbWl0IjpbODM0LG51bGxdLCJzYXZlciI6eyJxdWFsaXR5Ijo0MH0sImNvbnZlcnQiOiJ3ZWJwIn0sInB1ciI6InZhcmlhdGlvbiJ9fQ==--9cd57b9520c4b014f2ac669cfaed159f6926fc1e/8b4e62fa-36f5-43d9-905a-f199640a5a1d.jpg.webp" } } ], "description": "", "kind": "photo_capture", "name": "Haag Key", "sort_order": 7 }, { "captured_photos": [], "description": "", "kind": "photo_capture", "name": "Ridge Cap", "sort_order": 8 } ], "state": "submitted", "submitted_at": "2025-01-28T20:20:29.365Z", "title": "Exterior Storm Damage", "total_photos": 34, "type": "damage" } ``` ``` -------------------------------- ### Create Job Response Example (JSON) Source: https://developers.hover.to/reference/createajob This JSON snippet illustrates a successful 201 response when creating a new job via the HOVER REST API's `/api/v1/jobs` endpoint. It includes details about the created job, such as its ID, organization, location, customer information, and status. ```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" } } } ``` -------------------------------- ### GET /websites/developers_hover_to_reference Source: https://developers.hover.to/reference/createajob Retrieves details related to developer resources for Hover to Reference websites. ```APIDOC ## GET /websites/developers_hover_to_reference ### Description Retrieves specific data related to the developer resources for Hover to Reference. ### Method GET ### Endpoint /websites/developers_hover_to_reference ### Parameters #### Query Parameters * None ### Request Example ```json {} ``` ### Response #### Success Response (200) - **org_id** (number) - The organization ID. - **places_logo** (object) - Contains the URL for the places logo. - **url** (string) - The URL of the places logo. - **primary_color** (object) - The primary color branding. - **r** (number) - Red component. - **g** (number) - Green component. - **b** (number) - Blue component. - **secondary_color** (object) - The secondary color branding. - **r** (number) - Red component. - **g** (number) - Green component. - **b** (number) - Blue component. - **tertiary_color** (object) - The tertiary color branding. - **r** (number) - Red component. - **g** (number) - Green component. - **b** (number) - Blue component. - **model_terrain_color** (object) - The color for the model terrain. - **r** (number) - Red component. - **g** (number) - Green component. - **b** (number) - Blue component. - **client_branding_logo_url** (string/null) - URL for client branding logo, or null. - **created_at** (string) - Timestamp of creation. - **cust_serv_city** (string/null) - Customer service city, or null. - **cust_serv_contact** (string/null) - Customer service contact information, or null. #### Response Example ```json { "org_id": 39, "places_logo": { "url": "https://hover.to/api/v1/orgs/39/brand/places_logo.png" }, "primary_color": { "r": 36, "g": 125, "b": 220 }, "secondary_color": { "r": 36, "g": 125, "b": 220 }, "tertiary_color": { "r": 36, "g": 125, "b": 220 }, "model_terrain_color": { "r": 102, "g": 153, "b": 102 }, "client_branding_logo_url": null, "created_at": "2023-07-25T20:20:50.240Z", "cust_serv_city": null, "cust_serv_contact": null } ``` ``` -------------------------------- ### GET /websites/{website_id}/developers_hover_to_reference Source: https://developers.hover.to/reference/createajob Retrieves a list of items associated with a specific website project. ```APIDOC ## GET /websites/{website_id}/developers_hover_to_reference ### Description Retrieves a list of items associated with a specific website project. This endpoint provides detailed information about each item, including its properties, creation timestamps, and associated organization and owner details. ### Method GET ### Endpoint `/websites/{website_id}/developers_hover_to_reference` ### Parameters #### Path Parameters - **website_id** (number) - Required - The unique identifier of the website project. #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **items** (array) - A list of item objects, each containing the following properties: - **archived** (boolean) - Indicates if the item is archived. - **archived_at** (string) - Timestamp when the item was archived (nullable). - **created_at** (string) - Timestamp when the item was created. - **id** (number) - The unique identifier of the item. - **job_id** (number) - The identifier of the associated job. - **kind** (string) - The type or category of the item. - **lead_state** (string) - The current state of the lead associated with the item. - **ordering_state** (string) - The current ordering state of the item. - **org** (object) - Details about the organization associated with the item: - **ancestral_name** (string) - The full hierarchical name of the organization. - **customer_display_name** (string) - The display name of the customer organization. - **id** (number) - The unique identifier of the organization. - **kind** (string) - The type or category of the organization. - **model_price** (number) - The price associated with the organization's model. - **name** (string) - The name of the organization. - **ordering_email** (string) - The ordering email for the organization. - **parent_id** (number) - The identifier of the parent organization. - **sort_order** (any) - Sorting order information (nullable). - **updated_at** (string) - Timestamp when the organization was last updated. - **owner** (object) - Details about the owner associated with the item (structure similar to 'org' object). #### Response Example ```json { "items": [ { "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 } } ] } ``` ``` -------------------------------- ### POST /websites/developers_hover_to_reference Source: https://developers.hover.to/reference/createajob This endpoint is used to create or reference developer-related website data. The provided JSON response example illustrates the structure of a successful creation, returning details of the created or referenced job. ```APIDOC ## POST /websites/developers_hover_to_reference ### Description This endpoint is used to create or reference developer-related website data. The provided JSON response example illustrates the structure of a successful creation, returning details of the created or referenced job. ### Method POST ### Endpoint /websites/developers_hover_to_reference ### Parameters #### Request Body This endpoint expects a JSON payload containing job details. Specific fields would be defined by the API schema, but generally would include information to create or identify a job. ### Request Example ```json { "job_details": { "name": "Sample Project", "customer_email": "user@example.com" } } ``` ### Response #### Success Response (201 Created) - **job** (object) - Contains the details of the created or referenced job. - **id** (integer) - Unique identifier for the job. - **org_id** (integer) - Identifier for the organization associated with the job. - **name** (string) - The name of the job. - **org_name** (string) - The name of the organization. - **user_name** (string) - The username of the user associated with the job. - **user_id** (integer) - The ID of the user associated with the job. - **location_line_1** (string) - First line of the job's location. - **location_city** (string) - The city of the job's location. - **location_region** (string) - The region (state/province) of the job's location. - **location_postal_code** (string) - The postal code of the job's location. - **location_country** (string) - The country of the job's location. - **customer_name** (string) - The name of the customer. - **customer_email** (string) - The email of the customer. - **created_at** (string) - Timestamp when the job was created. - **updated_at** (string) - Timestamp when the job was last updated. - **state** (string) - The current state of the job (e.g., 'uploading'). - **machete_features** (array) - List of features enabled for this job. - **machete_blob** (object) - Contains sources for various job-related data like geometry, metadata, and products. #### Response Example ```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" } } } } ``` ``` -------------------------------- ### GET /websites/developers_hover_to_reference Source: https://developers.hover.to/reference/createajob Retrieves branding and reference information for a specific website or organization. ```APIDOC ## GET /websites/developers_hover_to_reference ### Description Retrieves branding and reference information for a specific website or organization, including primary, secondary, and tertiary email colors, as well as logo details. ### Method GET ### Endpoint `/websites/developers_hover_to_reference` ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example GET /websites/developers_hover_to_reference ### Response #### Success Response (200) - **id** (number) - The unique identifier for the organization. - **email_primary_color** (object) - The primary color scheme for emails. - **b** (number) - Blue component of the RGB color. - **g** (number) - Green component of the RGB color. - **r** (number) - Red component of the RGB color. - **email_secondary_color** (object) - The secondary color scheme for emails. - **b** (number) - Blue component of the RGB color. - **g** (number) - Green component of the RGB color. - **r** (number) - Red component of the RGB color. - **email_tertiary_color** (object) - The tertiary color scheme for emails. - **b** (number) - Blue component of the RGB color. - **g** (number) - Green component of the RGB color. - **r** (number) - Red component of the RGB color. - **logo** (object) - Information about the organization's logo. - **nonretina** (object) - URL for the non-retina version of the logo. - **url** (string) - The URL of the non-retina logo. - **retina** (object) - URL for the retina version of the logo. - **url** (string) - The URL of the retina logo. - **thumb** (object) - URL for the thumbnail version of the logo. - **url** (string) - The URL of the thumbnail logo. - **url** (string) - The default URL for the logo. - **model_background_color** (object) - The background color for models. - **b** (number) - Blue component of the RGB color. - **g** (number) - Green component of the RGB color. - **r** (number) - Red component of the RGB color. #### Response Example ```json { "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": 125, "r": 36 } } ``` ```