AgentResponseSchema
uuidAgent's UUID
first_nameAgent's first name
last_nameAgent's last name
emailAgent's email address
phoneAgent's phone number
AgentTeamResponseSchema
company_idID of the company this agent team belongs to
nameAgent team name
AssignmentResponseSchema
idAssignment ID
inspection_idID of the associated inspection
inspector_idID of the assigned inspector
primaryWhether this is the primary assignment
google_calendar_idGoogle Calendar event ID
hiddenWhether this assignment is hidden
pay_amountPayment amount for this assignment
pay_reasonReason for the payment amount
requestedWhether the assignment was requested
created_atCreation timestamp
updated_atLast update timestamp
deleted_atDeletion timestamp
BuyerResponseSchema
first_nameBuyer's first name
last_nameBuyer's last name
emailBuyer's email address
phoneBuyer's phone number
mobile_phoneBuyer's mobile phone number
home_phoneBuyer's home phone number
notesGeneral notes about the buyer
private_notesPrivate notes (not shared with the buyer)
CompanyResponseSchema
idCompany ID
slugCompany slug identifier
nameCompany name
emailCompany email address
phoneCompany phone number
websiteCompany website URL
video_urlCompany video URL
descriptionCompany description
image_urlCompany logo image URL
image_2_urlCompany secondary image URL
cityCity
stateState
countryCountry
addressStreet address (only if public)
zipZIP or postal code (only if public)
latLatitude (only if public)
lngLongitude (only if public)
service_radiusService radius in miles
service_areaService area description
multi_inspectorWhether the company has multiple inspectors
inspection_countTotal number of inspections
accepts_paymentWhether the company accepts payments
us_basedWhether the company is US-based
can_receive_bnpl_paymentsWhether the company can receive BNPL payments
eligible_for_auto_enrollWhether the company is eligible for auto-enrollment
pac_eligibleWhether the company is eligible for pay-at-close
payment_processorPayment processor type
type_of_signatureType of signature used
company_typeCompany type classification
currency_symCurrency symbol
time_zone_identifierTime zone identifier
sms_enabledWhether SMS is enabled
email_enabledWhether email is enabled
plural_client_labelPluralized client label
can_customize_smsWhether the company can customize SMS messages
over_free_inspection_limitWhether the company is over the free inspection limit
has_trialed_advancedWhether the company has trialed advanced features
is_trialing_advancedWhether the company is currently trialing advanced features
unread_conversations_countNumber of unread conversations
segment_originalOriginal segment classification
segment_updatedUpdated segment classification
settingsCompany settings
created_atCompany creation timestamp
updated_atCompany last update timestamp
ConnectionResponseSchema
agent_idThe agent's global ID in Spectora, shared across all companies this agent is associated with. Two different companies may have different connection IDs for the same agent, but the agent_id will be the same.
agent_uuidThe agent's globally unique identifier (UUID), shared across companies.
first_nameAgent's first name
last_nameAgent's last name
emailAgent's email address
phonePrimary phone number
second_phoneSecondary phone number
addressStreet address
full_addressFull formatted address
cityCity
stateState
countryCountry
zipZIP or postal code
agency_idID of the associated agency
agency_nameName of the associated agency
agency_phoneAgency phone number
company_idThe ID of your Spectora company that this agent belongs to.
cc_emailCC email address(es), comma-separated
notesGeneral notes about the agent
private_notesPrivate notes
birthday_monthBirthday month
birthday_dayBirthday day
facebook_linkFacebook profile URL
linkedin_linkLinkedIn profile URL
twitter_linkTwitter/X profile URL
instagram_linkInstagram profile URL
tiktok_linkTikTok profile URL
websiteWebsite URL
imageProfile image URL
thumbThumbnail image URL
tag_listList of tag names
List of tag objects
notes_idsIDs of associated notes
buying_agent_inspectionsNumber of inspections where this agent was the buying agent
selling_agent_inspectionsNumber of inspections where this agent was the selling agent
total_inspections_countTotal number of inspections for this agent
not_show_recommended_contractors_on_reportsWhether to hide recommended contractors on reports
date_of_first_inspectionDate and time of the agent's first inspection. Only included when requested via optional_fields=date_of_first_inspection.
ConnectionCreateRequestSchema
first_nameAgent's first name (cannot contain special characters : / @)
last_nameAgent's last name (cannot contain special characters : / @)
emailAgent's email address
phoneAgent's primary phone number
mobile_phoneAgent's mobile phone number
home_phoneAgent's home phone number
second_phoneAgent's secondary phone number
addressStreet address
cityCity
stateState
zipZIP or postal code
agency_nameName of the associated agency. If provided and agency doesn't exist, it will be created.
agency_phoneAgency phone number
cc_emailCC email address(es) for communications. Supports multiple emails separated by commas.
notesGeneral notes about the agent
private_notesPrivate notes (not shared with the agent)
birthday_monthBirthday month (1-12)
birthday_dayBirthday day (1-31)
facebook_linkFacebook profile URL
linkedin_linkLinkedIn profile URL
twitter_linkTwitter/X profile URL
instagram_linkInstagram profile URL
tiktok_linkTikTok profile URL
websitePersonal or business website URL
tag_listList of tags to associate with this agent
not_show_recommended_contractors_on_reportsWhether to hide recommended contractors on reports for this agent
imageProfile image file (multipart/form-data upload)
ConnectionUpdateRequestSchema
first_nameAgent's first name (cannot contain special characters : / @)
last_nameAgent's last name (cannot contain special characters : / @)
phoneAgent's primary phone number
mobile_phoneAgent's mobile phone number
home_phoneAgent's home phone number
second_phoneAgent's secondary phone number
addressStreet address
cityCity
stateState
zipZIP or postal code
agency_nameName of the associated agency. If provided and agency doesn't exist, it will be created.
agency_phoneAgency phone number
cc_emailCC email address(es) for communications. Supports multiple emails separated by commas.
notesGeneral notes about the agent
private_notesPrivate notes (not shared with the agent)
birthday_monthBirthday month (1-12)
birthday_dayBirthday day (1-31)
facebook_linkFacebook profile URL
linkedin_linkLinkedIn profile URL
twitter_linkTwitter/X profile URL
instagram_linkInstagram profile URL
tiktok_linkTikTok profile URL
websitePersonal or business website URL
tag_listList of tags to associate with this agent. Replaces existing tags.
not_show_recommended_contractors_on_reportsWhether to hide recommended contractors on reports for this agent
imageProfile image file (multipart/form-data upload)
ConnectionStatResponseSchema
agent_idThe agent's global ID in Spectora, shared across all companies this agent is associated with.
first_nameAgent's first name
last_nameAgent's last name
emailAgent's email address
phoneAgent's primary phone number
agency_nameName of the associated agency
agency_phoneAgency phone number
agency_idID of the associated agency
company_idThe ID of your Spectora company that this agent belongs to.
cc_emailCC email address
notesGeneral notes about the agent
private_notesPrivate notes (not shared with the agent)
birthdayAgent's birthday
imageProfile image URL
buying_agent_inspectionsCount of inspections where this agent was the buying agent.
selling_agent_inspectionsCount of inspections where this agent was the selling agent.
buying_inspections_countNumber of inspections where this agent was the buying agent.
selling_inspections_countNumber of inspections where this agent was the selling agent.
total_inspections_countTotal inspection count (buying + selling).
buying_inspections_quoteTotal revenue (quote sum) from inspections where this agent was the buying agent.
selling_inspections_quoteTotal revenue (quote sum) from inspections where this agent was the selling agent.
total_inspections_quoteTotal revenue (quote sum) from all inspections (buying + selling).
overall_inspections_countCombined inspection count from buying_agent_inspections + selling_agent_inspections.
first_inspection_dateDate of the agent's first inspection (earliest of buying and selling).
last_inspection_dateDate of the agent's most recent inspection (latest of buying and selling).
List of tag objects associated with this agent
ContactResponseSchema
buyer_idThe client's global ID in Spectora (internally called 'buyer ID'), shared across all companies this client is associated with. Two different companies may have different contact IDs for the same client, but the buyer_id will be the same.
company_idThe ID of your Spectora company that this client belongs to.
first_nameClient's first name
last_nameClient's last name
emailClient's email address
phonePrimary phone number
home_phoneHome phone number
mobile_phoneMobile phone number
cc_emailCC email address
addressStreet address
cityCity
stateState
zipZIP or postal code
notesGeneral notes about the client
private_notesPrivate notes
show_as_companyWhether displayed as a company
tag_listList of tag names
List of tag objects
image_urlProfile image URL
ContactCreateRequestSchema
emailClient's email address. If a buyer (global client record) with this email already exists, the client will be linked to the existing buyer.
first_nameClient's first name (cannot contain special characters : / @)
last_nameClient's last name (cannot contain special characters : / @)
phoneClient's primary phone number
home_phoneClient's home phone number
mobile_phoneClient's mobile phone number
cc_emailCC email address for communications
addressStreet address
cityCity
stateState
zipZIP or postal code
notesGeneral notes about the client
private_notesPrivate notes (not shared with the client)
tag_listList of tags to associate with this client
show_as_companyWhether to display this client as a company
imageProfile image file (multipart/form-data upload)
ContactUpdateRequestSchema
first_nameClient's first name (cannot contain special characters : / @)
last_nameClient's last name (cannot contain special characters : / @)
phoneClient's primary phone number
home_phoneClient's home phone number
mobile_phoneClient's mobile phone number
cc_emailCC email address for communications
addressStreet address
cityCity
stateState
zipZIP or postal code
notesGeneral notes about the client
private_notesPrivate notes (not shared with the client)
tag_listList of tags to associate with this client
show_as_companyWhether to display this client as a company
CustomFieldResponseSchema
nameCustom field name
identifierCustom field identifier
priorityDisplay priority/order
response_formatExpected response format
requiredWhether this field is required
choicesAvailable choices (raw string)
mobileWhether this field is available on mobile
valueCurrent value of the custom field
custom_field_template_idID of the custom field template
choices_arrayAvailable choices as a formatted array
InspectionResponse
Related resources requested via the 'include' query parameter. Contains full data for relationships. Each item contains id, type, attributes, and may include its own relationships.
InspectionResponseSchema
slugUnique slug identifier for the inspection
datetimeScheduled date and time of the inspection
durationDuration of the inspection in hours
paidWhether the inspection has been fully paid. Includes pay-at-close completed status.
order_idExternal order/reference ID
descriptionAdditional description or notes about the inspection
agreements_presentWhether inspection agreements are present
agreements_signedWhether all inspection agreements have been signed
notesGeneral notes about the inspection
request_notesNotes from the inspection request
published_atWhen the inspection report was published
created_atWhen the inspection was created
updated_atWhen the inspection was last updated
cover_photo_urlURL of the cover photo for the inspection
cover_photo_thumb_urlURL of the cover photo thumbnail
archived_by_inspectorWhether the inspection has been archived by the inspector
deleted_atWhen the inspection was soft-deleted
confirmedWhether the inspection has been confirmed
canceled_atWhen the inspection was canceled
datetime_formattedHuman-readable formatted date and time
buyer_nameName of the buyer
full_addressFull address of the property being inspected
property_addressStreet address of the property
property_address_2Secondary address line (unit, apt, etc.)
image_urlURL of the property image
quoteQuoted price for the inspection (formatted as string)
buying_agent_nameName of the buying agent
selling_agent_nameName of the selling agent
buying_agent_emailEmail of the buying agent
buying_agent_phonePhone number of the buying agent
selling_agent_emailEmail of the selling agent
selling_agent_phonePhone number of the selling agent
inspector_nameName of the assigned inspector
buying_agent_idID of the buying agent
selling_agent_idID of the selling agent
service_namesComma-separated list of service names
service_add_on_namesComma-separated list of service add-on names
buyer_namesNames of all buyers
cancel_reasonReason for cancellation if inspection was canceled
isn_idISN (Inspection Support Network) ID if applicable
payment_method_providedWhether a payment method has been provided
pay_at_close_display_statusDisplay status for pay-at-close transactions
is_client_completeWhether the client has completed all required steps
tooltipCustom tooltip text for calendar display. Only included when include_custom_tooltip parameter is true.
Safe settings for the inspection
charge_at_formattedFormatted charge date and time
referral_sourceReferral source for the inspection
discount_codeDiscount code applied to the inspection
InspectionAttachmentListResponse
Pagination metadata
Pagination links
InspectionAttachmentResponseSchema
idAttachment ID
nameAttachment name
file_file_nameOriginal file name
created_atCreation timestamp
updated_atLast update timestamp
inspection_idID of the associated inspection
descriptionAttachment description
reportWhether this attachment is a report. When false, it is an additional document.
internal_onlyWhether this attachment is for internal use only
file_urlURL to download the file
InspectionAttachmentCreateRequestSchema
inspection_idID of the inspection to attach this file to
nameDisplay name for the attachment. If not provided, defaults to the uploaded file name.
descriptionDescription of the attachment
fileThe file to upload. Supported types: images (jpg, jpeg, png, gif), PDF, ZIP, plain text, audio (mp3), Word, Excel, and PowerPoint documents.
reportWhether this attachment is a report. When false, it is an additional document. Defaults to false.
internal_onlyWhether this attachment is for internal use only. Defaults to false.
PropertyResponseSchema
idProperty ID
addressStreet address
address_2Secondary address line (unit, apt, etc.)
cityCity
stateState
zipZIP or postal code
countryCountry
full_addressFull formatted address
latLatitude
lngLongitude
square_feetProperty square footage
lot_sizeLot size
year_builtYear the property was built
bedroomsNumber of bedrooms
bathroomsNumber of bathrooms
parkingParking information
google_places_idGoogle Places ID
zillow_idZillow property ID
imageProperty image URL
TagResponseSchema
idTag ID
company_idID of the company this tag belongs to
nameTag name
colorTag color (hex code)
created_atTag creation timestamp
updated_atTag last update timestamp
auto_tagging_ruleAuto-tagging rule configuration
auto_tagging_enabledWhether auto-tagging is enabled
auto_tagging_remove_on_failWhether to remove tag when auto-tagging rule fails
auto_tagging_personType of person for auto-tagging (connections or contacts)

