/
FI
fireserviceusa
Search skmtc…
⌘K
Docs from a schema
Docs
Sign in
Docs
History
Schema
Generate
Filter operations
Account
41
AccountType
6
Activity
15
ActivityType
5
Address
13
AddressType
5
Admin
57
AdminAddressesV2
10
AdminHolidays
6
AdminMagicPlan
6
AdminReconcileAccounts
10
AdminReconcileAddresses
33
AdminReconcileContacts
7
AdminReconcileReferringEntities
7
AdminSiteSettings
2
AdminTempAgencies
5
AdminTempAgencyPayRates
5
AdminTemporaryWorkers
5
AdminVehicles
11
AdSource
6
ArStatement
12
BulkDataExport
4
Calendar
80
CalendarEventType
5
Category
5
Channel
11
Contact
38
ContactType
6
CopyJobException
4
CustomerPortal
65
Dashboard
29
Division
6
EntityDocuments
9
EntityPhotos
7
Equipment
23
EspJob
18
EspRequest
17
ESPSetup
8
ExternalAuth
2
ExternalPayment
14
FieldDocumentation
7
FingerprintAnalysis
8
FTPRPApproval
12
FTPRPHeaders
9
FTPRPJob
2
FTPRPLines
8
Hobbies
5
HurricaneScopeSheet
4
IntegrationLog
2
InvoicePayment
20
Job
165
post
/api/v1/Jobs/CreateLetterPDF
Update letter properties (in holding state)
post
/api/v1/Jobs/RegenerateLetterPDF
Super Admin only: rebuild an existing letter PDF from stored letter fields/signatures (layout fixes) without clearing signatures or opening recreate mode.
post
/api/v1/Jobs/DownloadLetterUnsigned
Generate an unsigned letter PDF (no Azure upload, no document record, no note). Requires rep signature + required fields; customer signature is not required. Returns the raw base64 PDF string for immediate browser download.
post
/api/v1/Jobs/{jobId}/UpdateLetter
Update letter properties (in holding state)
post
/api/v1/Jobs/Upload/Diagram
Upload Job Diagram
delete
/api/v1/Jobs/Diagaram/{diagramId}
Delete Job Diagram
get
/api/v1/Jobs/Diagram/{diagramId}
Download Diagram
get
/api/v1/Jobs/DiagramDataPoints/{diagramId}
Get Diagram Data Points
post
/api/v1/Jobs/{jobId}/Upload/Images
Upload Job Image
get
/api/v1/Jobs/{jobId}/Images
Get Job Images <param name="jobId"></param>
delete
/api/v1/Jobs/Photos/{id}
Delete Job Photo
put
/api/v1/Jobs/Photo
Update Job Photo
post
/api/v1/Jobs/{jobId}/Upload/Docs
Upload Job Doc
post
/api/v1/Jobs/{jobId}/Upload/Letter
Upload Job Doc
get
/api/v1/Jobs/{jobId}/WorkAuthURL
Get Job WorkAuth
get
/api/v1/Jobs/{jobId}/WorkAuthRefresh
Get Job WorkAuth
get
/api/v1/Jobs/GetDiagrams/{jobId}
Get Job Documents
get
/api/v1/Jobs/{jobId}/Docs
Get Job Documents
delete
/api/v1/Jobs/Docs/{id}
Delete Job Document
put
/api/v1/Jobs/Docs
Update Job Document
get
/api/v1/Jobs/{jobId}/LinkedSpecialInstructions
Get Job Notes
get
/api/v1/Jobs/{jobId}/Notes
get
/api/v1/Jobs/{jobId}/Notes/BusinessDevelopment
Active Business Development notes for a job, its project(s), and sibling jobs on those projects. Filtered server-side for efficiency.
put
/api/v1/Jobs/Note
Update Job Note
post
/api/v1/Jobs/Note
Create Job Note by Id
delete
/api/v1/Jobs/Note/{noteId}
Delete Job Note
post
/api/v1/Jobs/AddProject/{projId}/ToJob/{jobId}
Add Project To Job
delete
/api/v1/Jobs/RemoveProject/{projId}/FromJob/{jobId}
Remove job from project
post
/api/v1/Jobs/IntegrateJobs/{jobId}
Super Admin - Integrate Jobs
post
/api/v1/Jobs/UpdateReconciled/JobId/{jobId}/Status/{status}
Update Reconciled Status
get
/api/v1/Jobs/GetJobAndBillAccountContacts/{jobId}
Get Active Job And Bill Account Contacts
get
/api/v1/Jobs/{jobId}/AssessmentReports
Assessment reports for a job, newest first. One job can have many.
get
/api/v1/Jobs/Letters/{jobId}
Get Job Letters
get
/api/v1/Jobs/Letters/{jobId}/{letterType}
Get Job Letters
post
/api/v1/Jobs/{jobId}/AddCompanionJob/{newProjectId}/Project/{oldProjectId}
Add Companion Job
get
/api/v1/Jobs/TimelineFields/{jobType}
get
/api/v1/Jobs/{jobId}/TransactionDetails/{type}
get
/api/v1/Jobs/{jobId}/DryLogs
Get Dry Logs for Job
post
/api/v1/Jobs/{jobId}/DryLogs
Create Dry Log
put
/api/v1/Jobs/DryLogs/{dryLogId}/Record
Record Dry Log
put
/api/v1/Jobs/{jobId}/ClearSignature/{signatureType}
get
/api/v1/Jobs/{jobId}/Transactions/AA/Summary
Get Summary of AA Transactions
get
/api/v1/Jobs/{jobId}/Transactions/AA/Detail/Level/{level}/Element/{element}/Phase/{phase}
Get Aa Detail Transactions
get
/api/v1/Jobs/BackChargeRpt/{activeStatus}/Transactions/AA/Detail/{reconciled}/{startDate}/{endDate}
Back charge report
get
/api/v1/Jobs/{activeStatus}/Transactions/AA/Detail/{backChargeRpt}/{startDate}/{endDate}
Get All Aa Detail Transactions Job Transaction Rpt
get
/api/v1/Jobs/Invoices/Paid/AA/Detail/CommissionPeriodId/{comPeriodId}
Get All Aa Detail Transactions
get
/api/v1/Jobs/{jobId}/HasJobBeenPhased
Check if a job has been phased (phases with revenue). Default: at least two. Diller teams: at least one.
get
/api/v1/Jobs/{jobId}/SmsOptions
Get SMS options for a job, including active technicians and deduped recipients.
post
/api/v1/Jobs/{jobId}/Sms/VehicleEta
Get vehicles (with GPS when available) for SMS vehicle ETA. Pass UserIds for assigned-vehicle lookup, VehicleDataIds for explicit vehicle selection, or both.
post
/api/v1/Jobs/{jobId}/Sms/Enroll
Enroll an SMS recipient entity (account, contact, or referring entity).
post
/api/v1/Jobs/{jobId}/Sms
Send SMS for a job and create an audit note.
get
/api/v1/Jobs/{jobId}/JobContacts
Get Job Contacts
post
/api/v1/Jobs/{jobId}/CreateJobContact/{contactId}/{customDesc}/{limitEdit}
Create Job Contacts
put
/api/v1/Jobs/UpdateJobContact
Update Job Contact
delete
/api/v1/Jobs/{jobId}/DeleteJobContact/{contactId}
Delete Job Contacts. Optionally cascade remove to linked project and/or sibling jobs.
get
/api/v1/Jobs/{jobId}/Emails
Get Job Emails
post
/api/v1/Jobs/Jobs/Emails
Get Jobs Emails
post
/api/v1/Jobs/EmailJobPhotos
Email Job Photos
post
/api/v1/Jobs/DownloadPhotosAsZip
Download Photos as zip
post
/api/v1/Jobs/EmailPDF
Email Pdf Job Cover
get
/api/v1/Jobs/Photo/{blobContainer}/{jobId}/{photoUrl}
Download Image
get
/api/v1/Jobs/WorkAuth/{blobContainer}/{jobId}/LetterType/{letterType}
Download work auth
get
/api/v1/Jobs/DownloadWorkAuthUnsigned/{jobId}
post
/api/v1/Jobs/SubmitCatPack
SubmitCatPack � generates a signed PDF, stores it in blob, marks the JobDocument as IsSigned.
get
/api/v1/Jobs/DownloadCatPack/{jobId}
DownloadCatPack � returns the submitted CatPack PDF as base64. Falls back to generating on-the-fly.
get
/api/v1/Jobs/DownloadCatPackDraft/{jobId}
DownloadCatPackDraft � generates a draft CatPack PDF on-the-fly (no submission required). Works even if the undersigned has not yet signed.
post
/api/v1/Jobs/EmailCatPack
EmailCatPack � emails the CatPack PDF (submitted or draft) to the provided recipients.
post
/api/v1/Jobs/RemoveCatPack
RemoveCatPack � clears the submitted CatPack PDF, resets IsSigned, and optionally wipes all signatures.
post
/api/v1/Jobs/RedoCatPack
RedoCatPack � inserts a brand-new blank CatPack JobDocument so the job reloads as a fresh form. The previous document history is preserved (not deleted).
get
/api/v1/Jobs/{jobId}/CatPackURL
GetCatPackUrl � returns the UriString of the most recent submitted CatPack document.
get
/api/v1/Jobs/Download/{documentId}/Job/{jobId}/Letter/{letterType}
Download letter
get
/api/v1/Jobs/GetLetterUrl/{documentId}
Get letter url
post
/api/v1/Jobs/EmailWorkAuth
post
/api/v1/Jobs/EmailWorkAuthUnsigned
post
/api/v1/Jobs/EmailRemoteWorkAuthRequest
Email Remote Work Auth Request
post
/api/v1/Jobs/EmailRemoteCatPackRequest
post
/api/v1/Jobs/DownloadPhotoSheetPDF
DownloadPhotoSheetPDF with optional aggressive compression
post
/api/v1/Jobs/EmailPhotoSheetPDF
EmailPhotoSheetPDF with optional aggressive compression
post
/api/v1/Jobs/EmailInvoice/{docType}
Email Pdf Invoice
post
/api/v1/Jobs/JobWorkAuthsInProj
Email Pdf Job Cover
post
/api/v1/Jobs/CopyWorkAuthorizatin/FromJobId/{fromJobId}/ToJobId/{toJobId}/DocId/{docId}
CopyWorkAuthorization
post
/api/v1/Jobs/ResyncWorkAuth/JobId/{jobId}
ResyncWorkAuth
post
/api/v1/Jobs/UpdateWorkAuthorizationFromProject
UpdateWorkAuthorizationFromProject
post
/api/v1/Jobs/SubmitAccountingAuthorization/{jobId}
SubmitAccountingAuthorization
post
/api/v1/Jobs/RemoveAccountingAuthorization/{jobId}
RemoveAccountingAuthorization
post
/api/v1/Jobs/SubmitWorkAuthorization
SubmitWorkAuthorization
post
/api/v1/Jobs/SubmitWorkAuthorizationFromProject
SubmitWorkAuthorization
post
/api/v1/Jobs/RemoveWorkAuthorization
post
/api/v1/Jobs/{jobId}/Upload/Signature
Upload Job Signature
post
/api/v1/Jobs/{jobId}/Upload/LetterSignature
Upload Job Signature
post
/api/v1/Jobs/{jobId}/Clear/LetterSignature
Clear a customer or rep signature on a letter in holding state.
get
/api/v1/Jobs/JobDataForLetter/{jobId}/{letterType}
Get Job data for letter
get
/api/v1/Jobs
Get all Jobs
post
/api/v1/Jobs
Create Job
get
/api/v1/Jobs/List
Get Job List
post
/api/v1/Jobs/JobsListInfinite
Get Job List Infinite Scroll
post
/api/v1/Jobs/JobsReviewListInfinite
Get Job Review List Infinite Scroll
post
/api/v1/Jobs/JobsManagementReportInfinite
Get Job management Report infinite
get
/api/v1/Jobs/{activeStatus}/Report/{startDate}/{endDate}
Get Job management Report
get
/api/v1/Jobs/favorites
post
/api/v1/Jobs/favorites/{jobId}
delete
/api/v1/Jobs/favorites/{jobId}
get
/api/v1/Jobs/{id}
Get Job by Id
get
/api/v1/Jobs/{id}/eligible-loyalty-referrers
Get eligible loyalty referrers for a job
get
/api/v1/Jobs/Search
Search Jobs
get
/api/v1/Jobs/SearchJobModelWithAreas
put
/api/v1/Jobs/{jobId}/AutoUpdate/{autoUpdate}
Update Job
put
/api/v1/Jobs/{jobId}/UseSecondaryWorkAuth/{useSecondaryWorkAuth}
put
/api/v1/Jobs/{jobId}/ForceUseSecondaryAuth/{forceUseSecondaryAuth}
put
/api/v1/Jobs/Copy/{jobId}
Copy Job
post
/api/v1/Jobs/ToggleActiveStatusJob
Inactivate Job
put
/api/v1/Jobs/FullyPaid
Update Job Fully Apply Field
put
/api/v1/Jobs/Transactions/AR/{arTrxDocNumber}/PaidAmount/{paidAmount}/CashReceipts/{cashReceipts}
Update ArTrxHdr with paid amount
post
/api/v1/Jobs/{jobId}/VerifyActuals
Verify Job Actuals � refreshes ActualRev/ActualPay before close so that the loyalty-rewards preview and the close call itself operate on current data. Call this once before opening the close flow; the close/force-close endpoints no longer call RefreshJobActualsAndFullyPaidAsync themselves.
post
/api/v1/Jobs/{jobId}/Close/ReasonCodeId/{reasonCodeId}/CommissionPeriodId/{commissionPeriodId}
Close Job
post
/api/v1/Jobs/{jobId}/ForceClose/ReasonCodeId/{reasonCodeId}/CommissionPeriodId/{commissionPeriodId}
Close Job
post
/api/v1/Jobs/{jobId}/ReOpen/ReasonCodeId/{reasonCodeId}
Re-Open Job
post
/api/v1/Jobs/ProjectJobs
Create Project Jobs
get
/api/v1/Jobs/{id}/project-siblings-for-review
Get unreviewed, open sibling jobs belonging to the same project as the specified job. Used by the UI to offer batch-confirm during job review.
post
/api/v1/Jobs/bulk-review
Bulk-review a list of jobs, optionally applying the project hierarchy and BusDevUser. Only jobs that are not already reviewed, closed, or inactive are processed.
put
/api/v1/Jobs/Review/{updateProjJobs}
Review Job
get
/api/v1/Jobs/CommissionPeriods
Get Commission Periods
delete
/api/v1/Jobs/{jobId}
Delete Job
post
/api/v1/Jobs/{jobId}/AddressesV2/{addressV2Id}
Assign AddressV2 to Job (sets JobAddressIdV2)
delete
/api/v1/Jobs/{jobId}/AddressesV2/{addressV2Id}
Remove AddressV2 from Job (set JobAddressIdV2 to null)
post
/api/v1/Jobs/{jobId}/MarkFTPRPComplete
Mark FTPRP Complete for a job
post
/api/v1/Jobs/{jobId}/MarkFTPRPReopen
Reopen FTPRP for a job
get
/api/v1/Jobs/Estimates
Get Job Estimates
get
/api/v1/Jobs/Estimates/{id}
Get Single Job Estimate
delete
/api/v1/Jobs/Estimates/{id}
Delete Job Estimate
get
/api/v1/Jobs/{jobId}/EstimateIdByJobId
Get Estimate Id By Job
get
/api/v1/Jobs/{jobId}/Estimates
Get Estimate By Job
put
/api/v1/Jobs/{jobId}/Estimates
Update Job Estimate
post
/api/v1/Jobs/{jobId}/Estimates
Create Job Estimate
get
/api/v1/Jobs/{jobId}/clearEstimate
Clear job estimate
get
/api/v1/Jobs/{jobId}/Estimates/Elements
Get Elements for Job Estimate
get
/api/v1/Jobs/Estimates/Phases
Get all Job Estimate Phases
post
/api/v1/Jobs/Estimates/Phases
Create Job Estimate Phase
get
/api/v1/Jobs/Estimates/Phases/{id}
Get Single Job Estimate Phase
put
/api/v1/Jobs/Estimates/Phases/{id}
Update Job Estimate Phase
delete
/api/v1/Jobs/Estimates/Phases/{id}
Delete Job Estimate Phase
get
/api/v1/Jobs/{jobId}/Transactions/Job
Get Job Transactions By Job
get
/api/v1/Jobs/{activeStatus}/Transactions/Job/{startDate}/{endDate}
Get Job Transactions for all jobs
put
/api/v1/Jobs/Transactions/Job
Update Job Trx
post
/api/v1/Jobs/Transactions/Job
Create Job Trx
post
/api/v1/Jobs/Transactions/Job/Fee
Create Job Transaction which represents an automated fee
post
/api/v1/Jobs/Transactions/Job/CreditCardFee
Create Job Transaction which represents an automated fee
delete
/api/v1/Jobs/Transactions/Job/{trxId}
Delete Job Transaction
post
/api/v1/Jobs/Transactions/Job/{jobTrxId}/Approve
Approve Job Trx
post
/api/v1/Jobs/Transactions/Job/{jobTrxId}/ApproveGPOnly
Approve Job Trx
post
/api/v1/Jobs/Transactions/Job/{jobTrxId}/Integrate/{intLogId}/{reIntegrate}
Integrate Job trx
get
/api/v1/Jobs/{jobId}/RelatedEmergencyServiceUnpaidInvoices
For Mold Remediation / Repair jobs: find unpaid Invoice AR trx on related open Emergency Service jobs linked via the same project(s) (ProjectJobs) that also share a Job or Bill AddressV2 with the source job.
get
/api/v1/Jobs/{jobId}/Transactions/AR
Get AR Transactions By Job
get
/api/v1/Jobs/{activeStatus}/Transactions/AR/{startDate}/{endDate}
Get AR Transactions for all jobs
post
/api/v1/Jobs/Transactions/ARTrxApproval
Ar Transaction Approval, Infinite Scroll
post
/api/v1/Jobs/Transactions/JobTrxApproval
Job Transaction Approval, Infinite Scroll
put
/api/v1/Jobs/Transactions/AR
Update AR Trx
post
/api/v1/Jobs/Transactions/AR
Create AR Trx
put
/api/v1/Jobs/ArTrxApprovalUpdate
Update AR Trx Approval
post
/api/v1/Jobs/Transactions/AR/{arTrxId}/Approve
Approve Ar Trx
put
/api/v1/Jobs/JobTrxApprovalUpdate
Update Job Trx Approval
post
/api/v1/Jobs/Transactions/AR/{arTrxId}/ApproveGPOnly
Approve Job Trx in GP, skip is submitted check
delete
/api/v1/Jobs/Transactions/AR/{arTrxId}
Delete AR Transaction
post
/api/v1/Jobs/Transactions/AR/{arTrxId}/Integrate/{intLogId}/{reIntegrate}
Integrate Job trx
put
/api/v1/Jobs/Transactions/AR/Void
Void AR Invoice - Creates Reversing Credit Memo
JobElement
10
JobHistory
3
JobInactivateReview
3
JobNotice
19
JobPhase
7
JobPhoto
4
JobReferral
17
JobStatus
7
JobType
20
LoginHistory
8
MagicPlanWebhook
4
Note
6
Notification
29
Payment
4
PaymentSettings
6
PaymentSystemSettings
4
Project
52
ProjectReferral
4
ReasonCode
8
Reconcile
8
RefContactClass
5
RefEntityAdminAssignment
2
ReferrersApi
58
ReferringEntitiesHierarchy
3
ReferringEntityClass
5
ReferringEntityRelationships
8
ReferringEntityTypes
5
Reporting
26
ReviewDryLog
3
Role
14
StripeWebhook
2
SubChannel
5
SubJobType
6
SupplyUsage
7
Team
13
TeamPosition
5
TempWorkerSignIns
7
TempWorkerTimeEntries
12
TimeApproval
10
TimeEntry
9
TwilioSms
1
UserPreference
11
Vendors
2
VideoProcessing
3
Videos
14
Xactimate
20
Job
Copy
Copy Markdown
Copy Markdown
Copying…
Copied
Copy failed
Changes to Super Admin only: rebuild an existing letter PDF from stored letter fields/signatures (layout fixes) without clearing signatures or opening recreate mode.
post
/api/v1/Jobs/RegenerateLetterPDF
Sep 18, 2026
1689ae8c1eb4
Revision changes
info
endpoint added