RoofKit
Developer docsPartner API
API keys

Schemas

53 models
ApiKeyScopeenum
  • leads.read
  • leads.write
  • leads.export
  • analytics.read
  • analytics.manage
  • sales_visualizer.use
  • reports.read
  • reports.write
  • reports.export_pdf
  • reports.export_technical
  • reports.approve
  • reports.assistant.use
ApiKeySelfobject
  • idrequiredstring

    Stable API key identifier. This is not the secret.

  • namerequiredstring
  • masked_keyrequiredstring
  • scopesrequiredarray
WorkspaceSelfobject
  • idrequiredstring

    Bound workspace identifier.

  • namerequiredstring
ErrorCodeenum
  • UNAUTHORIZED
  • FORBIDDEN
  • RATE_LIMITED
  • VALIDATION_ERROR
  • NOT_FOUND
  • CONFLICT
  • INTERNAL_ERROR
ErrorResponseobject
  • errorrequiredobject
CursorPaginationobject
  • limitrequiredinteger
  • next_cursorrequiredstring | null
  • has_morerequiredboolean
Attributionobject
  • sourcestring | null
  • mediumstring | null
  • campaignstring | null
  • contentstring | null
  • conversion_urlstring | null:uri
AttributionOverridesobject
  • sourcestring | null
  • mediumstring | null
  • campaignstring | null
  • contentstring | null
JsonRecordobject
object
AttributionRangeobject
  • fromrequiredstring:date-time
  • torequiredstring:date-time
  • timezonerequiredstring
AttributionMetricsobject
  • lead_countrequiredinteger
  • conversion_countrequiredinteger
  • conversion_raterequirednumber
  • avg_lead_to_sold_secondsrequirednumber | null
  • funnel_gap_countrequiredinteger
  • funnel_gap_raterequirednumber
  • funnel_gap_stage_countsobject
  • stage_countsrequiredobject
  • stagesrequiredarray
  • trendrequiredobject
  • trendsrequiredobject
  • automated_spend_centsrequiredinteger | null
  • other_costs_centsrequiredinteger | null
  • total_spend_centsrequiredinteger | null
  • prorated_spend_centsrequiredinteger | null
  • cpl_centsrequiredinteger | null
  • cpa_centsrequiredinteger | null
  • revenue_centsrequiredinteger | null
  • roasrequirednumber | null
  • currencyrequiredstring | null
AttributionRowobject
  • idrequiredstring
  • keyrequiredstring
  • labelrequiredstring
  • sourcerequiredstring | null
  • mediumrequiredstring | null
  • campaignrequiredstring | null
  • metricsrequiredAttributionMetrics
LeadSourcesResponseobject
LeadSourceDetailResponseobject
CampaignsResponseobject
CampaignMetricsResponseobject
PageViewEventWriteobject
  • external_event_idrequiredstring
  • session_idrequiredstring
  • page_urlstring | null:uri
  • referrer_urlstring | null:uri
  • user_agentstring | null
  • occurred_atstring:date-time
  • device_typeenum
  • landing_idstring | null
  • landing_namestring | null
  • landing_slugstring | null
FormSubmissionEventWriteobject
  • external_event_idrequiredstring
  • session_idrequiredstring
  • page_urlstring | null:uri
  • referrer_urlstring | null:uri
  • user_agentstring | null
  • occurred_atstring:date-time
  • submitted_atstring:date-time
  • form_idstring | null
  • form_namestring | null
  • form_selectorstring | null
  • contact_namestring | null
  • contact_emailstring | null:email
  • contact_phonestring | null

    US-only phone. Invalid or non-US values return VALIDATION_ERROR.

  • property_addressstring | null

    Optional property address. Empty, explicit US country, or US state + ZIP formats are accepted; clearly non-US values return VALIDATION_ERROR.

  • form_dataJsonRecord
  • attribution_paramsobject
  • consent_modeenum
  • consent_grantedboolean
EventTrackResponseobject
  • eventrequiredobject
  • duplicaterequiredboolean
  • createdrequiredboolean
FormSubmissionTrackResponseobject
  • eventrequiredobject
  • duplicaterequiredboolean
  • analytics_onlyrequiredboolean
  • recorded_analyticsrequiredboolean
  • lead_idrequiredstring | null
  • createdrequiredboolean
Leadobject
  • idrequiredstring
  • external_idstring | null
  • external_sourcestring | null
  • contact_namerequiredstring | null
  • contact_emailrequiredstring | null:email
  • contact_phonerequiredstring | null

    Stored phone digits for the lead.

  • property_addressrequiredstring | null

    Property address text for the lead.

  • is_partialrequiredboolean
  • statusrequiredstring
  • status_stage_idrequiredstring | null
  • status_labelstring | null
  • status_sort_orderinteger | null
  • is_conversion_stageboolean
  • stage_timestampsobject | null
  • funnel_gap_summaryobject | null
  • attributionrequiredAttribution
  • form_dataJsonRecord
  • custom_fieldsJsonRecord
  • selected_material_idstring | null
  • selected_color_idstring | null
  • selected_shape_idstring | null
  • notesstring | null
  • estimated_valuenumber | null
  • follow_up_datestring | null:date-time
  • converted_atstring | null:date-time
  • created_atrequiredstring:date-time
  • updated_atrequiredstring:date-time
LeadWriteobject
  • external_idstring | null
  • external_sourcestring | null
  • is_partialboolean
  • session_idstring | null
  • contact_namestring | null
  • contact_emailstring | null:email
  • contact_phonestring | null

    US-only phone. Invalid or non-US values return VALIDATION_ERROR.

  • property_addressstring | null

    Optional property address. Empty, explicit US country, or US state + ZIP formats are accepted; clearly non-US values return VALIDATION_ERROR.

  • form_dataJsonRecord
  • custom_fieldsJsonRecord
  • selected_material_idstring | null
  • selected_color_idstring | null
  • selected_shape_idstring | null
  • status_stage_idstring
  • attributionAttribution
  • marketing_attribution_overridesAttributionOverrides
  • notesstring | null
  • estimated_valuenumber | null
  • follow_up_datestring | null:date-time
LeadPatchobject
  • is_partialboolean
  • contact_namestring | null
  • contact_emailstring | null:email
  • contact_phonestring | null

    US-only phone. Invalid or non-US values return VALIDATION_ERROR.

  • property_addressstring | null

    Optional property address. Empty, explicit US country, or US state + ZIP formats are accepted; clearly non-US values return VALIDATION_ERROR.

  • form_dataJsonRecord
  • custom_fieldsJsonRecord
  • selected_material_idstring | null
  • selected_color_idstring | null
  • selected_shape_idstring | null
  • status_stage_idstring
  • attributionAttribution
  • marketing_attribution_overridesAttributionOverrides
  • notesstring | null
  • estimated_valuenumber | null
  • follow_up_datestring | null:date-time
LeadListResponseobject
LeadUpsertResponseobject
  • leadrequiredLead
  • createdrequiredboolean
ConversionWriteobject
  • external_event_idrequiredstring
  • session_idstring | null
  • visualization_idstring | null
  • conversion_urlstring | null:uri
  • contact_namestring | null
  • contact_emailstring | null:email
  • contact_phonestring | null

    US-only phone. Invalid or non-US values return VALIDATION_ERROR.

  • property_addressstring | null

    Optional property address. Empty, explicit US country, or US state + ZIP formats are accepted; clearly non-US values return VALIDATION_ERROR.

  • occurred_atstring:date-time
Conversionobject
  • idrequiredstring
  • lead_idrequiredstring
  • external_event_idrequiredstring | null
  • conversion_numberrequiredinteger
  • session_idrequiredstring
  • visualization_idstring | null
  • attributionrequiredAttribution
  • contact_namestring | null
  • contact_emailstring | null
  • contact_phonestring | null

    Phone snapshot at conversion time.

  • property_addressstring | null

    Property address snapshot at conversion time.

  • created_atrequiredstring:date-time
ConversionListResponseobject
  • conversionsrequiredarray
ConversionCreateResponseobject
  • conversionrequiredConversion
  • createdrequiredboolean
LeadRoofobject
  • lead_idrequiredstring
  • visualization_idrequiredstring | null
  • materialrequiredobject | null
  • colorrequiredobject | null
  • shaperequiredobject | null
  • imagesrequiredobject
  • processing_statusstring | null
  • processing_errorstring | null
ReportArtifactFormatenum
  • xml
  • csv
  • xlsx
  • dxf
  • pdf
  • json
  • zip
  • manifest
  • tif
  • png
  • jpg
  • jpeg
  • webp
  • gif
ReportStatusenum
  • importing
  • needs_review
  • draft
  • ready_for_review
  • approved
  • exporting
  • failed
  • archived
Reportobject
  • idrequiredstring
  • project_namerequiredstring
  • external_report_idrequiredstring | null
  • statusrequiredReportStatus
  • current_revision_idrequiredstring | null
  • baseline_revision_idrequiredstring | null
  • approved_revision_idrequiredstring | null
  • source_formatsrequiredarray
  • summaryrequiredobject
  • current_revision_numberrequiredinteger | null
  • project_addressrequiredstring | null
  • location_labelrequiredstring | null
  • location_latrequirednumber | null
  • location_longrequirednumber | null
  • created_atrequiredstring:date-time
  • updated_atrequiredstring:date-time
ReportExportArtifactobject
  • export_idrequiredstring
  • report_idrequiredstring
  • revision_idrequiredstring | null
  • formatrequiredReportArtifactFormat
  • roleenum
  • file_namerequiredstring
  • mime_typerequiredstring
  • size_bytesrequiredinteger
  • checksumrequiredstring
  • metadataobject
  • created_atstring:date-time
  • download_urlstring:uri
ReportListResponseobject
ReportDetailResponseobject
  • reportrequiredReport
  • exportsrequiredarray
ReportImportFormobject
  • filesrequiredarray
  • project_namestring
  • external_report_idstring
  • profile_keystring
  • coverage_innumber
  • stock_width_innumber
ReportImportResponseobject
  • report_idrequiredstring
  • baseline_revision_idrequiredstring
  • working_revision_idrequiredstring
  • assistant_thread_idrequiredstring
ReportExportRequestobject
  • revision_idstring
  • formatrequiredenum
ReportExportResponseobject
  • revision_idrequiredstring
  • exportsrequiredarray
VisualizationProcessingStatusenum
  • pending
  • processing
  • completed
  • failed
Visualizationobject
  • idrequiredstring
  • session_idrequiredstring
  • sourcerequiredconst: sales_visualizer
  • landing_idrequiredstring | null
  • landing_namerequiredstring | null
  • landing_slugrequiredstring | null
  • selected_material_idrequiredstring | null
  • selected_color_idrequiredstring | null
  • selected_shape_idrequiredstring | null
  • original_image_urlrequiredstring
  • processed_image_urlrequiredstring | null
  • processing_statusrequiredVisualizationProcessingStatus
  • processing_started_atrequiredstring | null:date-time
  • processing_completed_atrequiredstring | null:date-time
  • processing_errorrequiredstring | null
  • created_atrequiredstring:date-time
  • updated_atrequiredstring:date-time
VisualizationCreateobject
  • session_idrequiredstring
  • landing_idstring | null
  • landing_namestring | null
  • landing_slugstring | null
  • selected_material_idstring | null
  • selected_color_idstring | null
  • selected_shape_idstring | null
  • original_image_urlrequiredstring
VisualizationResponseobject
VisualizationGenerateRequestobject
  • photo_urlrequiredstring
  • material_namerequiredstring
  • color_namerequiredstring
  • color_hexstring
  • shape_namestring
  • reference_roof_image_urlstring

    Optional reference image as a secure HTTPS URL or data:image URL.

VisualizationGenerateResponseobject
VisualizationListResponseobject
ShareLinkCreateRequestobject
  • visualization_idrequiredstring:uuid
ShareLinkCreateResponseobject
ShareLinkPublicResponseobject
  • share_linkrequiredobject
  • visualizationrequiredobject
  • selectionsrequiredobject
  • rooferrequiredobject
  • landingrequiredobject | null
  • settingsrequiredobject | null
PipelineStageobject
  • idrequiredstring
  • labelrequiredstring
  • sort_orderrequiredinteger
  • system_keyrequiredstring | null
  • is_conversion_stagerequiredboolean
PipelineStagesResponseobject
  • stagesrequiredarray