There are two ways in. People who use ChatGPT, Claude or another AI assistant add the Hodos connector and sign in as themselves. Programs your company runs use the REST API with a key an admin creates.
The connector works with any assistant that supports MCP, the standard way AI apps plug into other software. Everyone connects with their own Hodos login, so a rep sees only what a rep sees in the app and an admin sees what an admin sees.
https://hodos.strutq.com/api/mcpclaude mcp add --transport http hodos https://hodos.strutq.com/api/mcpYou can now use Claude or ChatGPT with Hodos. It works as you, sees only what you can see in Hodos, and asks before it changes anything.
Set it up once, about a minute:
1. In Claude, open Settings, then Connectors, and choose Add custom connector. In ChatGPT, open Settings, then Apps and Connectors, turn on Developer mode, and choose Create.
2. Name it Hodos and paste this address: https://hodos.strutq.com/api/mcp
3. Choose Connect, sign in with your Hodos email and password, and choose Allow.
Then just ask, for example:
"Using Hodos, what are my tasks and appointments this week?"
"Using Hodos, book an inspection on the Smith job for Tuesday at 10 AM."
"Using Hodos, move the Smith job to the next stage."
It can email or text a customer only after you approve the exact message and recipient. It never calls a customer; calls still go out from the Hodos inbox.Menu names in ChatGPT and Claude change from time to time. If a step does not match, look for custom connectors or developer mode in that app's settings.
69 ways to look things up and 132 ways to change records. The full wording each assistant reads is in /llms.txt. A good assistant asks before it changes anything. Moving a stage, booking an appointment or creating a job runs your company's own Hodos automations, the same as doing it in the app.
read_hodos_rulesYour company's rules for how an agent works in Hodos: how to write notes, tasks, job updates, emails, and texts.
search_contactsFind people in the CRM by name, phone, or email.
search_jobsFind jobs by name, pipeline stage group, ownership, or outcome (open by default; won, lost and cancelled jobs are reachable with outcome).
get_jobOne job in full: stage and how long it has been there, the customer, the insurance claim if there is one, open tasks, and the checklist of what this stage still needs before the job can move forward.
list_my_tasksTasks assigned to the signed-in rep that are due today or overdue, or due within the next seven days.
list_my_appointmentsAppointments booked for the signed-in rep today, or across the next seven days.
pipeline_summaryHow many open jobs sit in each pipeline stage and what they are worth in total.
find_documentsThe paperwork filed on one job or one contact, with each document's plain-language summary and the kind it is filed under.
read_job_notesEverything said about one job, newest first: the notes people wrote (a reply names the note it answers in replyTo), the homeowner's own messages already on the record, and logged calls, alongside what happened to the job.
get_contactOne contact in full: phone, email, address, and the jobs they are on (as the main customer or in another role).
list_pipelinesEvery pipeline (workflow) in the company and its stages in order, with the ids change_job_stage and create_job need.
list_teamThe active people in the company with their role, so a task or appointment can name who it is for.
list_tasksTasks across the company that the rep can see, filtered by job, contact, who they are assigned to, and whether they are open or done.
find_claimsInsurance claims by claim number or carrier, with the job each belongs to.
list_job_filesEvery file on one job, photos included, with name, folder, kind, size, and contentSha256 (the stored bytes' fingerprint, when Hodos has one; the same value means an exact copy).
get_file_linkA private download link for one file, good for 10 minutes.
list_invoicesInvoices on one job, or the company's open invoices when no job is named: number, status, total, what is still owed, and due date.
list_paymentsMoney received on one job, newest first: amount, what it was for (deductible, ACV check, supplement and so on), how it was paid, the date, the receipt and check numbers, and the invoice it went to.
list_contractsThe contracts and agreements on one job, newest first: what kind each is, where it stands (draft, waiting on the rep, waiting on the homeowner, partly signed, completed, voided or replaced), and who has signed and when.
get_measurementsThe roof measurements on one job, one per roof: squares, roof area, pitch, waste, and the ridge, hip, valley, eave, rake and flashing lengths, with where they came from (EagleView, Hover, GAF, manual and others) and whether the report is ready.
get_job_payoutHow one job's profit is split: the overhead percent taken off the contract first, then each person's percent of the profit that is left.
get_job_moneyThe ids and amounts the money write tools need for one job: its estimates with their lines, the lines on its invoices, its supplements, its cost entries and budget lines, and its open online-payment flags for the office.
list_payment_typesThe payment types record_payment accepts for one job, the same list as Log payment on the job.
get_taskOne task by its exact id (from list_tasks or list_my_tasks), as Hodos holds it now: title, job or contact it is on, whether it is done, when it was finished and by whom, and when it last changed.
read_conversationThe newest email and text messages with one customer, both directions, so you can see how they replied.
list_callsRecent calls the rep can see, newest first: who, when, direction, outcome, length, and the AI call summary when there is one.
list_notificationsWhat is in the rep's bell right now: new tasks and jobs assigned to them, mentions, and customer texts and emails waiting on them, newest first, with unread flagged.
list_record_typesEvery kind of record you can read with read_records, grouped (jobs, contacts, money, claims, documents and photos, messages and calls, calendar and tasks, company setup, storms and canvassing, activity), each with what it holds and the columns that usually narrow it.
read_recordsRead one kind of record from Hodos (see list_record_types), newest first, with filters and paging: for example type files with a job_id filter, or type invoices with status eq open.
job_briefRead a compact job brief from the screens the signed-in person can see.
my_dayRead the signed-in person's due tasks, appointments, customer replies waiting, and unread notification bell count.
findSearch visible jobs, contacts, addresses, and claim numbers in one read-only request.
get_job_insuranceRead the canonical claim and evidence for an insurance job.
get_money_overviewRead a bounded canonical personal or company money view.
list_inboxList bounded inbox threads, or read one thread's bounded message history, without changing read state.
get_job_timelineRead one canonical page of visible job activity.
get_job_estimatesRead canonical saved estimate headers and one selected version.
list_job_paperworkRead a bounded canonical page of job paperwork.
get_homeRead the same canonical home sections visible to the caller.
read_company_settingsRead one canonical company settings catalog without running settings actions.
get_contact_relationshipsRead the canonical visible people and projects related to one person or project.
get_contact_referralsRead a visible contact's referred jobs.
get_production_work_orderRead one canonical visible production work order without exposing production actions.
get_job_contactsRead the same active contact relationships visible on a staging project.
list_projects_moneyRead a bounded page of the canonical staging Money projection for the caller's role.
list_productionRead a bounded page of visible staging production work orders and their materials.
read_job_team_chatRead the canonical bounded internal team chat without changing message read state.
get_job_foldersOne job's file setup: the company's Documents folder layout, folders the team made on this job, its photo folders with the photo ids in each, which file is the current scope of loss, and the share links still open (ids for turn_off_share_link).
find_duplicate_filesWhich files on a job are byte-for-byte the same file, by the contentSha256 list_job_files gives, the same check the app runs before an upload.
list_job_email_filesWhich of a job's files arrived on, or went out with, an email filed to the job, and (for admins) the PDFs on those emails not added to the job yet, with whether someone chose Don't add.
get_contract_draftThe questions a draft contract or agreement asks, by step, and the answers filled in so far, with the revision edit_contract_draft needs.
list_signing_linksWho on a job's paperwork is still waiting to sign, and when each signing link expires, the same as the paperwork hub's waiting list.
get_payment_detailsOne recorded payment's receipt (number, amount, method, who paid) and whether it can be voided or already was, the same as its receipt and Void button.
get_invoice_payment_scheduleThe scheduled payments on one invoice and which are paid, the same as the invoice's schedule.
get_job_originWhere a job came from (door knock, call, referral, import and so on), the same as the job's origin line.
find_propertyOne property (door) on the map, by id or by the point nearest a latitude and longitude, with its recent knocks and notes and the company's door statuses.
list_knocked_doorsThe doors knocked between two dates, for every rep or one, the same as the map's Knocked filter.
get_storm_infoStorm reads beside hail_at_address: the storm history and active warnings at a point, the live hail reports since a date, the storm margin areas for one storm, or the hail photos inside a map box.
get_team_locationsAdmins only, as on the map's Team layer: each active rep's latest location, or one rep's trail.
get_settings_infoRead-only admin views: the trash (deleted jobs and contacts that can be restored), the record number counters, the access profiles and their permissions, which outside connections are set up, and whether the old-data path is ready.
get_email_detailsRead-only.
get_reportsRead-only.
my_crew_workFor a crew member: the work orders and jobs their crew is on, 50 to a page, or one work order's instructions, checklist and photos, the same as the crew's work list in the app.
read_file_textThe written text of one PDF, Word (.docx) or text file on a job or contact, read page by page: use it to answer from the real estimate, scope, report or letter instead of its summary.
download_file_chunkThe stored bytes of any file on a job or contact, up to 1 MiB per call as base64 in contentBase64, so a file of any type or size (photos including HEIC, PDFs, Word and spreadsheets, video) can be fetched and put back together.
view_file_imageReturns one photo from a job as an image you can look at, shrunk to fit (long edge 1,568 pixels by default, up to 2,048) so large originals work.
hail_at_addressRead Hodos storm history for a job address or a typed US street address.
preview_emailGet the exact saved address, subject, and body a send_email would use, without sending anything.
preview_textGet the exact text and phone number a send_text would use, without sending anything.
add_job_noteWrite one internal note onto a job's timeline.
edit_noteReplace the words of a note the signed-in rep wrote, using a note id from read_job_notes.
delete_noteDelete one note the signed-in rep wrote, using a note id from read_job_notes.
post_job_team_chatPost one message in a job's team chat, the team-only conversation on the job (read it with read_job_team_chat).
start_team_chatOpen a direct team chat with teammates (ids from list_team), the same as starting a chat in the Inbox, or add people to an existing team chat by passing its thread_id.
post_team_chat_messagePost one message in an internal team chat in the Inbox, using a thread id from list_inbox or start_team_chat.
set_job_primary_contactMake one contact the job's main contact, the same as choosing the client on the job page.
move_to_trashMove a job or contact to Trash, the same as Delete on the record in the app.
restore_from_trashRestore a job or contact from Trash, the same as Restore in Settings, Trash.
archive_jobArchive a job off the board, or bring an archived one back with restore true, the same as Archive project on the board.
link_call_to_jobFile one call (ids from list_calls) on a job, move it to another job, or take it off its job with job_id null, the same as the job picker on a call.
set_custom_fieldSet one of the company's custom fields on a job or contact, the same as editing it in the record's details.
update_jobChange details on one job the rep can see: its name, street address, city, state, ZIP, priority, value in dollars, date of loss, description, trades, lead source, start and end dates, referrer, and tags.
update_job_claimSet or fix insurance claim details on a visible job.
update_contactChange details on one contact the rep can see: person/company kind, first and last name, display name, phone (a US number), email, street address, city, state, ZIP, tags, lead source, source detail, and referral partner status.
update_taskWork on one existing task (ids from list_tasks or list_my_tasks).
update_appointmentChange one existing appointment (ids from list_my_appointments or get_job).
create_taskCreate one task, assigned to the signed-in rep unless assignee_ids names teammates (ids from list_team), optionally attached to a job or a contact.
log_activityRecord that something already happened on a job: a site visit, a call that took place outside Hodos, an adjuster meeting.
archive_filesMove up to 50 of a job's photos, videos, or documents into its Archived folder, the same as Archive in the app.
restore_filesMove up to 50 archived photos, videos, or documents back out of Archived, the same as Move out of Archived in the app.
move_filesMove up to 50 of a job's documents into one of its folders, the same as Move to in the app.
add_contact_noteWrite one internal note onto a contact's timeline, for a person with no job yet or a fact about the person rather than a job.
book_appointmentPut an appointment on the Hodos calendar for a job, a contact, or a personal Meeting with no client.
change_job_stageMove a job to a different stage, in its own pipeline or in another one (the app's Move to pipeline).
create_contactAdd a new person to Hodos.
create_jobOpen a new job for an existing contact in one of the company's pipelines.
add_contact_to_jobPut another person on a job, such as a spouse, tenant, adjuster, or insurance agent, with their role.
create_invoiceCreate a one-line invoice on a job that has none yet.
add_invoice_chargeAdd a line to a job's contract invoice: a charge on a retail job, or a supplement on an insurance job.
record_paymentRecord money a job has already received, the same as Log payment on the job in the app.
set_job_payoutSet one job's payout split by hand, the same as the Payout editor on the job.
assign_job_peopleChange who is on a job's team, the same as the Team block on the job.
create_estimateStart a blank draft estimate on a job, the same as New estimate on the job.
update_estimate_linesAdd, change, or remove lines on a draft estimate in one step, the same edits the estimate screen makes.
decline_estimateRecord that the customer turned an estimate down, the same as Decline on the estimate.
delete_draft_estimateDelete an estimate that was never sent, the same as Delete draft on the estimate.
remove_invoice_chargeTake a charge or supplement line that was added to a job's contract invoice back off, the same as Remove on that line.
apply_payment_to_invoiceCount a payment the company already recorded (see list_payments) toward an invoice, the same as Apply payment on the invoice.
add_invoice_creditAdmins only.
add_job_costAdd a cost the company paid on a job, the same as Add cost on the job's money tab.
remove_job_costDelete a cost entry from a job, the same as Remove on the cost.
update_supplementMove a supplement through its stages on the job: draft, submitted, approved, partial, or denied, the same as the supplement screen.
set_payment_noteWrite or clear the note on a recorded payment, the same as the note on its receipt.
void_paymentVoid a payment someone logged by hand (check, cash and the like) with a reason, the same as Void on the payment.
create_side_job_invoiceStart a separate bill on a job for extra work outside the contract, the same as Side Job on Make Payment Link.
convert_estimate_to_invoiceMake the invoice for an estimate the customer already signed, the same as Create invoice on that estimate.
edit_invoice_linesAdd, change or remove lines on a draft invoice the rep made by hand, the same as the Items list on that invoice.
add_budget_linePlan what a job should cost, one line at a time, the same as Add budget line on the Budget screen.
mark_job_cost_paidRecord that the company paid a cost on a job, or take that back with a reason, the same as Paid on the cost.
set_job_costs_completeSay every cost on a job is in, or open it back up, the same as Costs complete on the job's money tab.
mark_payout_paidAdmins only.
resolve_payment_flagClear a flag an online payment raised for the office (for example money that could not be matched), the same as Handled on the flag.
undo_supplement_email_approvalTake back a supplement approval Hodos filed from a carrier's email, the same as Undo on that approval card.
void_contractVoid a job's contract with a reason, the same as Void on the contract.
report_gapUse this when the rep asks for something this connector cannot do, or a tool fails in a way the rep cannot fix.
set_task_doneSet one task (exact id from list_tasks, list_my_tasks, or get_task) to done true or done false.
set_email_pdf_dismissedDon't add, or Bring back, a PDF from an email filed to the job, the same as on the job's Documents.
edit_document_folderMake a new folder on a job's Documents, rename one the team made, or remove one, the same as the folder menu in the app.
put_files_in_folderPut up to 50 of a job's documents in a folder the team made, or take them out of it with folder_id left out, the same as dragging a file in or out of that folder in the app.
edit_photo_folderMake a new photo folder on a job, rename one, or remove one, the same as the folder menu on the job's Photos.
move_photos_to_folderPut up to 50 of a job's photos in one of its photo folders, or take them out of every folder with folder_id left out, the same as Move to folder on the job's Photos.
refile_inspection_photoFile one of a job's photos under a shot of its inspection, or back to Unsorted with shot_id left out, the same as Move to on the job's Photos.
make_current_scopeMark one of a job's files as the current scope of loss, the same as Make current SOL on its Documents.
delete_filesAdmins only, as in the app: reps archive with archive_files instead.
make_share_linkMake a private link the rep can copy and send themselves, the same as Share in the app: job_page opens the job's page for a homeowner or a sub (ends in 7, 14 or 30 days), document opens one file (14 days), photos opens chosen photos or all of the job's photos (30 days), photo_folder opens one photo folder as an album (7, 30 or 90 days, or never).
turn_off_share_linkStop a share link from opening, the same as Revoke in the app.
create_material_orderStart a draft material order on a job, the same as New material order: empty, with lines, from a signed estimate, or for one trade's work order (work_order_id).
edit_material_orderChange a draft material order's delivery date or notes, and add, change or remove its lines, the same as the order's editor.
move_material_orderMove a material order one step: draft to submitted, submitted to confirmed, confirmed to delivered, the same as the order's status button.
link_material_order_to_work_orderTie a material order already on the job to one trade's work order, or take it off with work_order_id left out, the same as using a spare order for a trade on the Production tab.
create_work_orderMake the work order for a signed estimate, the same as Create work order in the production handoff.
update_work_order_checklistOn a work order: attach a photo to a checklist item (which marks it done) or take it off, or answer one question on one of its forms, the same as the work order page.
set_scope_tradesTake trades of the carrier's scope of loss off the contract, or put them back, the same as the trade ticks on the scope card.
manage_crewAdmins only, as in the app.
set_crew_insuranceAdmins only.
create_subcontractorAdmins only.
edit_subcontractorAdmins only.
start_estimateStart an empty estimate on a job, retail or insurance, the same as Start estimate on the job.
restore_estimate_versionMake an earlier version of an estimate the newest one again, the same as Restore in the estimate's versions list.
make_proposal_linkMake the homeowner's link to an estimate's proposal, the same as Copy link in the estimate editor.
create_contract_draftStart a draft contract or other agreement on a job, the same as New contract, or the contract for a retail estimate the homeowner accepted (estimate_id).
edit_contract_draftSet answers on a draft contract or agreement, by the field ids get_contract_draft lists, the same as typing them in the contract editor.
replace_contractReplace a contract that is out for signing with a fresh draft carrying the same answers, the same as Replace on its signing review.
edit_supplementChange one line of a draft supplement (quantity, price, reason, or whether it is included) or its letter, the same as the supplement panel.
edit_supplement_ruleAdmins only.
save_contract_sectionPut a custom contract section on the company's saved list, or refresh the wording of the one saved under that title, the same as Save for company in the contract editor.
update_claim_moneyOn a job's claim money card: say whether the claim has a mortgage company, when depreciation was requested, and add, change or remove a carrier check still coming or paid to the homeowner.
undo_scope_email_stage_movePut a job back where it was after Hodos moved it on its own because a carrier scope arrived by email, the same as Undo on that line of the job's history.
change_job_payoutAdmins only, as in the app.
review_cost_documentApprove a bill or receipt filed on a job and post its cost lines, or reject it, the same as Review on the job's costs.
start_inspectionStart a guided inspection on a job (quick_inspect or roof_claim), the same as Start inspection on the job.
skip_inspection_sectionMark one section of an open guided inspection as skipped, with the reason the office sees, the same as Skip on the phone.
complete_inspectionFinish an open guided inspection, the same as Finish in the inspection.
save_roof_measurementsSet a roof's measurements by hand, the same as the manual measurements editor: squares, eave, ridge, valley, rake and hip linear feet, and waste percent.
drop_map_pinPut a new door on the map at a point, the same as dropping a pin.
edit_propertyChange a door's homeowner name, phone or email, the same as the door's details.
remove_propertyArchive a door so it leaves the map for everyone (restorable from Leads, Archived), or, admins only, delete doors that have no knocks or linked records, the same as in the app.
log_door_knockRecord a knock at a door with its status (ids from find_property statuses) and an optional note, or add a note alone, the same as the door panel.
book_door_inspectionBook an inspection at a door, the same as Book on the phone's door sheet: it adds the homeowner as a contact, opens a job (or uses existing_job_id), and books the appointment.
record_door_follow_upSave the homeowner at a door and when to come back, the same as Follow up on the phone's door sheet.
door_jobMake a job from a door (property_id), the same as Convert to job on the map, or from a typed address, the same as Create job on an address's hail panel; or put an existing job on a door (link_job_id); or start a door inspection, which opens the job and its inspection together.
edit_territoryAdmins only, as in the app.
watch_addressPut a door, or a job's or contact's address, on the rep's watchlist with a reason and when to revisit (after the next storm, 30 or 90 days), the same as Watch; or stop a watch.
update_storm_alert_or_hail_photoRecount a storm alert's doors and jobs, the same as Refresh on the alert; or delete a hail photo pin the rep took (admins can delete any), the same as Delete on the photo.
edit_pipeline_settingsAdmins only.
edit_door_statusAdmins only.
list_inspection_checklistsAdmins only.
edit_inspection_checklistAdmins only.
edit_photo_checklistAdmins only.
edit_estimate_template_lineAdmins only.
edit_competitionAdmins only.
manage_contract_publicationAdmins only, from Settings, Contract templates.
edit_automationAdmins only.
set_company_logoAdmins only.
delete_import_batchAdmins only.
pin_messagePin one message to the top of a conversation, or unpin it (message_id null), the same as Pin in the inbox.
needs_replylist shows who is waiting on a reply; done takes one off Needs Reply without answering, the same as Done in the inbox; restore puts it back.
cancel_unsent_textCancel a text still waiting to send (for example held for quiet hours), the same as Cancel on that message.
conversation_owneropen finds or opens the text thread for a contact (and job), the same as opening their conversation, and sends nothing.
email_job_matchesAdmins only, the same as the inbox's match review.
call_recordsRecords only, no dialing.
call_follow_upintelligence reads a call's summary and suggested follow-up; receipt reads the follow-up already saved; confirm saves the follow-up task the rep agreed to, the same as Confirm on the call.
merge_duplicatesAdmins only.
make_pay_linkMake a pay link for an invoice the rep can see.
send_emailEmail one contact through the same guarded Hodos sender as the Inbox.
send_textText one contact from the rep's own Hodos number, the same as sending from the Hodos inbox.
upload_job_fileAttach one file (for example a PDF estimate the rep just made) to a job's files, the same as Upload in the app, so it shows on web and phone.
add_email_pdf_to_jobAdd to files on a PDF from an email filed to the job, the same as on the job's Documents.
prepare_job_file_uploadUse for files larger than 3 MiB, instead of sending the original in one MCP request.
upload_job_file_chunkSend one consecutive part from prepare_job_file_upload, indexed from zero, as base64 without whitespace or a data: prefix.
finalize_job_file_uploadCall after every part of prepare_job_file_upload has been received.
Texts, emails and calls go out from the Hodos inbox, where consent and opt-out checks run. An assistant can draft the words for you to send.
For a program rather than a person. An admin creates a key in Hodos under Settings, API access, picks what it may do and when it expires, and copies the secret once. A key sees only its own company and never more than the admin who made it.
https://hodos.strutq.com/api/v1Send the key on every call, then check it works:
curl https://hodos.strutq.com/api/v1/me \
-H "Authorization: Bearer $HODOS_API_KEY"curl "https://hodos.strutq.com/api/v1/jobs?limit=25" \
-H "Authorization: Bearer $HODOS_API_KEY"Download the Postman collection, import it, and paste your key into the apiKey variable. Run the folders from the top. List calls save an id that the calls after them use, and the test records are tagged or titled as Postman tests.
Each key carries only the scopes the admin ticks. Ticking one adds the scopes it depends on.
| Scope | Lets the key |
|---|---|
contacts.read | Read contact names, addresses, phone numbers and email addresses. |
contacts.update | Set, add or remove contact tags. Also needs contacts.read. |
jobs.read | Read jobs, insurance claims, and the pipelines and stages a job sits in. |
jobs.update | Set, add or remove job tags. Also needs jobs.read. |
notifications.read | Read the key owner's own Hodos notifications. An alert about a job, contact, task, file, call or appointment only appears if the key's access profile can also read that kind of record. |
notifications.update | Mark one or all of the key owner's notifications read. Also needs notifications.read. |
tasks.read | Read tasks, open and completed, and the teammates they can be assigned to. |
notes.read | Read the shared notes on a claim's job. Private notes stay hidden. Also needs jobs.read. |
files.read | List the shared photos and documents on a job or claim. Also needs jobs.read. |
files.download | Download those photos and documents. Also needs jobs.read and files.read. |
tasks.create | Create tasks, tied to a job or contact and assigned to teammates. Also needs tasks.read. |
tasks.update | Mark a task done, or reopen it. Also needs tasks.read. |
tasks.archive | Delete a task. It is archived, not destroyed, and drops out of the API. Also needs tasks.read. |
notes.create | Add a shared note to a job or claim, and tag teammates in it so they are notified. Finding teammate ids needs the Tasks scope. Also needs jobs.read and notes.read. |
files.create | Upload photos and documents to a job or claim, singly or up to 20 at a time. Also needs jobs.read and files.read. |
Every call, with its fields and response shapes, is in the OpenAPI document, which most code generators and AI agents read directly. The Postman collection has every call ready to run.
/meNo scopeReturns the key's id, its company (org_id), the scopes it can use right now, and when it expires. Call this first to confirm a key works. Needs no scope.
curl "https://hodos.strutq.com/api/v1/me" \
-H "Authorization: Bearer $HODOS_API_KEY"Lists the company's contacts (homeowners and other customers), newest first. Archived contacts are left out. Page through with cursor. Needs contacts.read.
curl "https://hodos.strutq.com/api/v1/contacts" \
-H "Authorization: Bearer $HODOS_API_KEY"Returns one contact by id. Needs contacts.read.
curl "https://hodos.strutq.com/api/v1/contacts/{id}" \
-H "Authorization: Bearer $HODOS_API_KEY"Changes the tags on a contact. Send set to replace them all, or add and/or remove to change some. Tags are 1 to 40 characters, up to 50 per contact, and matching ignores capitals. Repeating the same call changes nothing more. Needs contacts.read and contacts.update.
This call sends a body. See the worked examples under Responses and paging, or the OpenAPI document for every field.
Lists the company's jobs, newest first. Archived jobs are left out. Each job names its contact, its pipeline and the stage it sits in. Page through with cursor. Needs jobs.read.
curl "https://hodos.strutq.com/api/v1/jobs" \
-H "Authorization: Bearer $HODOS_API_KEY"Returns one job by id. Needs jobs.read.
curl "https://hodos.strutq.com/api/v1/jobs/{id}" \
-H "Authorization: Bearer $HODOS_API_KEY"Changes the tags on a job. Send set to replace them all, or add and/or remove to change some. Tags are 1 to 40 characters, up to 50 per job, and matching ignores capitals. Repeating the same call changes nothing more. Needs jobs.read and jobs.update.
This call sends a body. See the worked examples under Responses and paging, or the OpenAPI document for every field.
Adds a plain-text note to the job's timeline. The team sees it; the customer does not. List teammates in mention_user_ids (from the team list, up to 20) to tag them: each gets a Hodos alert and, unless they turned it off, an email, the same as a tag typed in the app. Send a unique Idempotency-Key. Needs jobs.read, notes.read and notes.create.
This call sends a body. See the worked examples under Responses and paging, or the OpenAPI document for every field.
Lists the company's job pipelines in board order, each with its stages in order, so a job's pipeline_id and stage_id can be shown by name. One page holds them all. Needs jobs.read.
curl "https://hodos.strutq.com/api/v1/pipelines" \
-H "Authorization: Bearer $HODOS_API_KEY"Lists file details (not the bytes) on the job, newest first. Download one with the file download call. Needs jobs.read and files.read.
curl "https://hodos.strutq.com/api/v1/jobs/{id}/files" \
-H "Authorization: Bearer $HODOS_API_KEY"Step 1 of 2 for one file. Reserves an upload and returns a one-time upload_url. PUT the raw bytes there with upload_metadata base64-encoded in an x-metadata header, then call finish upload. The Idempotency-Key must equal request_id. Needs jobs.read, files.read and files.create.
This call sends a body. See the worked examples under Responses and paging, or the OpenAPI document for every field.
Step 1 of 3 for many files. Reserves up to 20 uploads in one call; each answer carries its own status and upload, or an error. Repeating a request_id returns the same reservation. PUT each file's bytes to its upload_url (in parallel is fine), then call bulk finish. Needs jobs.read, files.read and files.create.
This call sends a body. See the worked examples under Responses and paging, or the OpenAPI document for every field.
Lists file details (not the bytes) on the claim's job. Download one with the file download call. Needs jobs.read and files.read.
curl "https://hodos.strutq.com/api/v1/claims/{id}/files" \
-H "Authorization: Bearer $HODOS_API_KEY"Returns the bytes of one file this key can see. Needs jobs.read, files.read and files.download.
curl "https://hodos.strutq.com/api/v1/files/{id}/download" \
-H "Authorization: Bearer $HODOS_API_KEY"Step 1 of 2. Reserves an upload for the claim's job and returns a one-time upload_url. PUT the raw bytes there with upload_metadata base64-encoded in an x-metadata header, then call finish upload. The Idempotency-Key must equal request_id. Needs jobs.read, files.read and files.create.
This call sends a body. See the worked examples under Responses and paging, or the OpenAPI document for every field.
Step 2 of 2. Checks the uploaded file's type, size and the checksum you declared match what was reserved, and adds the file to the job. Returns 202 if the bytes have not arrived yet; call again shortly. Needs jobs.read, files.read and files.create.
This call sends a body. See the worked examples under Responses and paging, or the OpenAPI document for every field.
Step 3 of 3 for many files. Checks each uploaded file against what was reserved and adds it to its job. Each answer carries its own status: 200 registered, 202 bytes not there yet (call again shortly), or an error. Needs jobs.read, files.read and files.create.
This call sends a body. See the worked examples under Responses and paging, or the OpenAPI document for every field.
Lists the company's tasks, newest first, open and completed. A task with completed_at set is done. Page through with cursor. Needs tasks.read.
curl "https://hodos.strutq.com/api/v1/tasks" \
-H "Authorization: Bearer $HODOS_API_KEY"Returns one task by id. Needs tasks.read.
curl "https://hodos.strutq.com/api/v1/tasks/{id}" \
-H "Authorization: Bearer $HODOS_API_KEY"Creates a task, optionally tied to a job or contact and assigned to teammates. Send a unique Idempotency-Key: repeating the same key with the same body returns the task already made (200) instead of a second copy, and reusing it with a different body returns 409. Needs tasks.create.
This call sends a body. See the worked examples under Responses and paging, or the OpenAPI document for every field.
Send {"completed": true} to mark the task done or {"completed": false} to reopen it. Doing the same thing twice is harmless. The job timeline records it as done by the key's owner. Needs tasks.update.
This call sends a body. See the worked examples under Responses and paging, or the OpenAPI document for every field.
Deletes a task the way the app does: it is archived, not destroyed, and no longer appears in task lists or reads. Deleting it twice returns not found. Needs tasks.archive.
curl -X DELETE "https://hodos.strutq.com/api/v1/tasks/{id}" \
-H "Authorization: Bearer $HODOS_API_KEY"Lists the company's active people with their name and role, so a task's assignee_id or a note's author_user_id can be shown by name, and assignee_ids can be filled when creating a task. One page holds them all. Needs tasks.read.
curl "https://hodos.strutq.com/api/v1/team" \
-H "Authorization: Bearer $HODOS_API_KEY"Lists insurance claims on jobs this key can see. Filter with claim_number. A claim number is not unique across carriers, so check the job before choosing a match. Needs jobs.read.
curl "https://hodos.strutq.com/api/v1/claims" \
-H "Authorization: Bearer $HODOS_API_KEY"Returns one claim with the job it belongs to. Needs jobs.read.
curl "https://hodos.strutq.com/api/v1/claims/{id}" \
-H "Authorization: Bearer $HODOS_API_KEY"Lists the shared notes on the claim's job, newest first. Needs jobs.read and notes.read.
curl "https://hodos.strutq.com/api/v1/claims/{id}/notes" \
-H "Authorization: Bearer $HODOS_API_KEY"Adds a plain-text note to the claim's job timeline. The team sees it; the customer does not. Send a unique Idempotency-Key. Needs jobs.read, notes.read and notes.create.
This call sends a body. See the worked examples under Responses and paging, or the OpenAPI document for every field.
Lists the Hodos notifications of the person who owns the key, newest first, each with whether it has been read. Add unread=true for only the unread ones. href is a Hodos path, such as /jobs/{id}. Needs notifications.read.
curl "https://hodos.strutq.com/api/v1/notifications" \
-H "Authorization: Bearer $HODOS_API_KEY"Marks one notification read, by the id the list gave. Needs notifications.read and notifications.update.
curl -X POST "https://hodos.strutq.com/api/v1/notifications/{id}/read" \
-H "Authorization: Bearer $HODOS_API_KEY"Marks everything up to now read for the key owner. Needs notifications.read and notifications.update.
curl -X POST "https://hodos.strutq.com/api/v1/notifications/read-all" \
-H "Authorization: Bearer $HODOS_API_KEY"Every answer is JSON with data and a request_id. Lists return up to limit records, 1 to 100, and a page.next_cursor. Pass it back as cursor for the next page and stop when it is null.
{
"data": [
{ "id": "6f1c", "name": "Smith roof replacement", "stage_id": "..." }
],
"page": { "next_cursor": "eyJ2Ijox" },
"request_id": "0b7e"
}Calls that make a new record (tasks, notes, single file uploads) need an Idempotency-Key header, unique per record. Sending the same key and body again returns the record already made instead of a second copy, so a retry after a dropped connection is always safe.
curl https://hodos.strutq.com/api/v1/tasks \
-X POST \
-H "Authorization: Bearer $HODOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"title":"Call the adjuster","priority":"high","due_date":"2026-10-06"}'Assign people by sending assignee_ids, ids from the team list. A task is marked done or reopened with PATCH and deleted with DELETE. A deleted task is archived, not destroyed, and leaves the task lists.
# Mark a task done (send false to reopen it)
curl https://hodos.strutq.com/api/v1/tasks/$TASK_ID \
-X PATCH \
-H "Authorization: Bearer $HODOS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"completed":true}'
# Delete a task (it is archived, not destroyed)
curl https://hodos.strutq.com/api/v1/tasks/$TASK_ID \
-X DELETE \
-H "Authorization: Bearer $HODOS_API_KEY"Tags are changed with PATCH. A note can tag teammates by their id from the team list: each one gets an alert in Hodos and an email, unless they turned that off. Files can go up to 20 at a time, and notifications are the key owner's own.
curl https://hodos.strutq.com/api/v1/jobs/$JOB_ID/tags \
-X PATCH \
-H "Authorization: Bearer $HODOS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"add":["supplement"],"remove":["new lead"]}'curl https://hodos.strutq.com/api/v1/jobs/$JOB_ID/notes \
-X POST \
-H "Authorization: Bearer $HODOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"body":"Supplement approved. Please invoice.","mention_user_ids":["'"$TEAMMATE_ID"'"]}'curl https://hodos.strutq.com/api/v1/jobs/$JOB_ID/notes \
-X POST \
-H "Authorization: Bearer $HODOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)" \
-H "Content-Type: application/json" \
-d '{"body":"Thanks, sending the invoice now.","in_reply_to":"'"$NOTE_ID"'"}'# 1. Reserve up to 20 uploads. Each file needs its own request_id and attachment_id (UUIDs) and its sha256.
curl https://hodos.strutq.com/api/v1/jobs/$JOB_ID/files/uploads/bulk \
-X POST \
-H "Authorization: Bearer $HODOS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"files":[{"request_id":"'"$REQ_1"'","attachment_id":"'"$ATT_1"'","name":"scope.pdf","kind":"scope","mime_type":"application/pdf","size_bytes":48213,"sha256":"'"$SHA_1"'"}]}'
# 2. PUT each file to its upload_url, with upload_metadata base64-encoded in x-metadata.
# 3. Finish them all at once.
curl https://hodos.strutq.com/api/v1/files/uploads/bulk-finalize \
-X POST \
-H "Authorization: Bearer $HODOS_API_KEY" \
-H "Content-Type: application/json" \
-d '{"intent_ids":["'"$INTENT_1"'"]}'curl "https://hodos.strutq.com/api/v1/notifications?unread=true" \
-H "Authorization: Bearer $HODOS_API_KEY"Each key can make 120 calls a minute and each company 1,200. Creating, changing or deleting tasks is capped at 30 a minute per key. The API cannot text, email or call customers, take payments, sign documents, or write to JobNimbus.
{
"error": { "code": "insufficient_scope", "message": "The API key does not have the required scope." },
"request_id": "0b7e"
}| Status | Code | Meaning |
|---|---|---|
| 400 | invalid_request | A field, parameter or cursor is wrong. Check the call against the OpenAPI document. |
| 401 | invalid_api_key | The key is missing, mistyped, revoked or expired, or its admin lost access. |
| 403 | insufficient_scope | The key is real but lacks the scope this call needs. |
| 404 | not_found | No record with that id, or the key cannot see it. |
| 409 | idempotency_conflict | That Idempotency-Key was already used with a different body. |
| 409 | upload_expired | The upload reservation ran out before the bytes arrived. Start again. |
| 413 | file_too_large | The file is over the size limit. |
| 422 | upload_metadata_mismatch | The uploaded file's type, size or declared checksum does not match what was reserved. |
| 429 | rate_limited | Over 120 calls a minute for one key, 1,200 for the company, or 30 task changes a minute for one key. Wait for Retry-After seconds. |
| 503 | service_unavailable | Hodos could not answer just now. Retry with backoff. |