API REFERENCE
Every operation available to your integration, with its parameters and responses.
Version v2GETFetches a list of company with filtering, sorting, and pagination options.
/api/v2/companies/listGETFetches a company by its ID./api/v2/companies/{companyId}DELETEDeletes a company by its ID./api/v2/companies/{companyId}GETFetches all addresses for a specific company./api/v2/companies/{companyId}/addressesPOSTCreates a new address for a specific company./api/v2/companies/{companyId}/addressesGETFetches notes for a specific company with pagination./api/v2/companies/{companyId}/notesGETReturns a list of company sales quote requests from the current user's access level with available filters
being AllOpen, AllUnacknowledged, AllComplete, and AllRequests./api/v2/companies/{companyId}/sales-quote-requestsGETFetches leads for a specific company with pagination./api/v2/companies/{companyId}/leadsGETFetches tasks for a specific company with pagination./api/v2/companies/{companyId}/tasksGETFetches contacts for a specific company with pagination and optional search./api/v2/companies/{companyId}/contactsGETFetches opportunities for a specific company with pagination./api/v2/companies/{companyId}/opportunitiesGETFetches equipment for a specific company with pagination and optional search./api/v2/companies/{companyId}/equipmentGETFetches assigned company reps with pagination and optional search./api/v2/companies/{companyId}/repsGETFetches sales quotes for a company with pagination and optional search./api/v2/companies/{companyId}/sales-quotesGETRetrieves the list of ranks associated with the specified company./api/v2/companies/{companyId}/ranksGETRetrieves all inventory requests within the time range, with optional inbound/outbound filters and pagination options for the provided company./api/v2/companies/{companyId}/inventory-requestsPOSTCreates a new company./api/v2/companiesPUTUpdates an existing company address./api/v2/companies/{companyId}/addresses/{addressId}DELETEDeletes an existing company address./api/v2/companies/{companyId}/addresses/{addressId}POSTCreates a new rep./api/v2/companies/repPUTUpdates an existing rep./api/v2/companies/rep/{id}DELETEDeletes a rep by its ID.
Deletes a rep by its ID./api/v2/companies/rep/{id}PATCHPartially updates a company/api/v2/companies/{id}PATCHPartially updates a company/api/v2/external/companies/{id}POSTCreates, updates or deletes a company/api/v2/external/companiesGETGets the company record by id.
/api/v2/contacts/{contactId}PUTUpdates an existing contact./api/v2/contacts/{contactId}DELETEDeletes a contact by ID./api/v2/contacts/{contactId}GETGets the list of contacts assigned to the company./api/v2/contacts/list/{companyId}GETRetrieves a list of contacts associated with a specified record type and record identifier./api/v2/contacts/list/by-record/{recordType}/{recordId}GETFetches a list of contacts with filtering, sorting, and pagination options./api/v2/contacts/listPOSTAdds a new contact to a company./api/v2/contactsPOSTAdds a new contact to a company./api/v2/external/contactsPOSTCompletes an assigned task for a deal
/api/v2/deals/{dealId}/tasks/{assignedTaskId}/completeGETGets all assigned documents for a deal./api/v2/deals/{dealId}/documentsGETDownloads an assigned document for a deal./api/v2/deals/{dealId}/documents/{assignedDocumentId}/downloadPATCHPartially updates an existing deal./api/v2/deals/{dealId}GETGets a list of termination reasons for deals./api/v2/deals/termination-reasonsGETGets a list of termination types for deals./api/v2/deals/termination-typesPUTTerminates a deal with the specified ID./api/v2/deals/{dealId}/terminateGETFetches equipment related to a specific record with pagination.
/api/v2/equipment/by-parentGETSearches available equipment makes matching the given term./api/v2/equipment/equipment/makes/searchGETFetches distinct equipment models for the given make./api/v2/equipment/equipment/models/searchPATCHPartially updates an equipment/api/v2/equipment/{id}GETFetches equipment details by its ID./api/v2/equipment/{id}PATCHPartially updates an equipment/api/v2/external/equipment/{id}DELETEDeletes an equipment by its ID./api/v2/equipment/{equipmentId}GETFetches a list of equipment with filtering, sorting, and pagination options./api/v2/equipment/listPOSTCreates a new equipment record./api/v2/equipmentPOSTCreates a new equipment record./api/v2/external/equipmentPATCHRemoves an attachment from its parent./api/v2/equipment/remove-attachment/{equipmentId}GETDownloads sample pdf from polaris./api/v2/equipment/polaris/sample/{labNumber}/download-pdfPOSTUploads one or more image files and assigns them to the specified equipment./api/v2/equipment/{equipmentId}/imagesGETGET /api/v2/equipment/{equipmentId}/images/api/v2/equipment/{equipmentId}/imagesComponents
GETFetches a single equipment component by ID.
/api/v2/equipment/components/{id}PUTUpdates an existing equipment component record./api/v2/equipment/components/{id}GETFetches a list of equipment components based on filters./api/v2/equipment/components/listPOSTCreates a new equipment component record./api/v2/equipment/componentsDELETEDeletes an equipment component record./api/v2/equipment/components/{componentId}GET
GETFetches a single assigned GET record by ID.
/api/v2/equipment/GETs/{id}PUTUpdates an existing equipment assigned get record./api/v2/equipment/GETs/{id}GETSearches manufacturers for GET components./api/v2/equipment/GETs/manufacturersGETSearches brands for GET components./api/v2/equipment/GETs/brandsGETSearches categories for GET components./api/v2/equipment/GETs/categoriesGETSearches styles for GET components./api/v2/equipment/GETs/stylesGETFetches a list of equipment assigned GET records based on filters./api/v2/equipment/GETs/listPOSTCreates a new equipment assigned get record./api/v2/equipment/GETsPOSTCreates new equipment assigned get image records./api/v2/equipment/GETs/imagesDELETEDeletes one or more images associated with a specified equipment assigned GET record./api/v2/equipment/GETs/imagesPOSTCreates new equipment assigned get records./api/v2/equipment/GETs/SelectedGETs/{equipmentId}DELETEDeletes an equipment assigned get record./api/v2/equipment/GETs/{assignedId}Categories
Undercarriage
POSTCreates a new undercarriage measurement for the specified equipment and returns the full reading details.
/api/v2/equipment/undercarriage/readingPUTUpdates a undercarriage measurement for the specified reading and returns the full reading details./api/v2/equipment/undercarriage/reading/{readingId}GETFetches full undercarriage reading details by reading ID, including measurements, images, and videos./api/v2/equipment/undercarriage/reading/{readingId}GETGET /api/v2/equipment/undercarriage/reading/{readingId}/download-pdf/api/v2/equipment/undercarriage/reading/{readingId}/download-pdfGETFetches a paged list of undercarriage readings for a given equipment./api/v2/equipment/undercarriage/reading/listGETFetches the signed-in user's inspections for the last `Days` days (paginated)./api/v2/equipment/undercarriage/reading/user/listPOSTUploads an image for a specific undercarriage reading component and location./api/v2/equipment/undercarriage/images/uploadPOSTUploads multiple undercarriage image files in bulk for a specific reading./api/v2/equipment/undercarriage/images/bulk-uploadPOSTUploads a video for a specific undercarriage reading component and location./api/v2/equipment/undercarriage/videos/uploadDELETEDeletes a reading video by its ID./api/v2/equipment/undercarriage/videos/{videoId}DELETEDeletes a reading image by its ID./api/v2/equipment/undercarriage/images/{imageId}POSTAnalyzes a scanned undercarriage inspection form image or PDF using Azure Document Intelligence./api/v2/equipment/undercarriage/form/analyzePM Service
GETFetches equipment assigned PM services for the current user.
/api/v2/equipment/assigned-pm-servicesGETFetches equipment assigned PM service by service id for the current user./api/v2/equipment/assigned-pm-services/{serviceId}PUTCompletes an equipment assigned PM service./api/v2/equipment/assigned-pm-services/complete/{serviceId}GETFetches a list of inspections based on record ID and type.
/api/v2/inspections/record/listGETFetches the signed-in user's inspections for the last `Days` days (paginated)./api/v2/inspections/record/user/listGETGets the inspection record with associated groups, items, and responses./api/v2/inspections/record/{assignedInspectionId}PUTUpdates an existing inspection record./api/v2/inspections/record/{assignedInspectionId}POSTCreates a new inspection record./api/v2/inspections/recordPOSTPre-registers a batch of images that will be uploaded for an inspection./api/v2/inspections/record/images/registerPOSTUploads an image file for a specific inspection item./api/v2/inspections/record/images/uploadPOSTUploads a video file for a specific inspection item./api/v2/inspections/record/videos/uploadPOSTUploads multiple image files for inspection items in bulk./api/v2/inspections/record/images/bulk-uploadDELETEDeletes inspection images by their IDs./api/v2/inspections/record/imagesDELETEDeletes inspection videos by their IDs./api/v2/inspections/record/videosPUTMarks an inspection record as completed after all required images have been uploaded./api/v2/inspections/record/{assignedInspectionId}/completeGETGET /api/v2/inspections/record/{assignedInspectionId}/download-pdf/api/v2/inspections/record/{assignedInspectionId}/download-pdfPOSTCreates an item and associates the inspection with the given request.
/api/v2/inventory-request/inspection/assignPOSTCalled when completing an inspection to handle inventory request assigned inspections./api/v2/inventory-request/inspection/completePOSTCreates an inventory request with no pricing information, if successfull returns inventory request ID for the new request./api/v2/inventory-request/requests/createliteGETRetrieves all inventory requests within the time range, with optional inbound/outbound filters and pagination options./api/v2/inventory-request/requests/listGETRetrieves details on a given inventory request, complete with items and associated tracking logs for said items./api/v2/inventory-request/requests/{inventoryRequestID}GETRetrieves profile rates via name filtering/api/v2/inventory-request/requests/rateprofiles/listGETRetrieves rate profile details/api/v2/inventory-request/requests/rateprofiles/detailsGETRetrieves inventory request types/api/v2/inventory-request/requests/typesGETRetrieves inventory request interval options/api/v2/inventory-request/requests/intervalsGETRetrieves the available makes and models of a given profile, can return empty list if none have been assigned./api/v2/inventory-request/requests/make-modelsGETRetrieves the price of a selected profile and rate, returns the price calculated, or 0 if no price could be obtained./api/v2/inventory-request/requests/pricingGETFetches a list of leads with filtering, sorting, and pagination options.
/api/v2/leads/listGETRetrieves a paginated list of leads associated with the specified record and record type./api/v2/leads/by-record/listGETRetrieves the details of a lead by its unique identifier./api/v2/leads/{leadId}PUTUpdates an existing lead by its ID./api/v2/leads/{leadId}DELETEDeletes an existing lead./api/v2/leads/{leadId}GETRetrieves a list of available lead statuses, optionally filtered by a search parameter./api/v2/leads/statusesGETRetrieves a list of available lead company sources, optionally filtered by a search parameter./api/v2/leads/sourcesGETRetrieves a list of lead reasons that match the specified search criteria./api/v2/leads/reasonsGETRetrieves a list of lead source locations that match the specified search criteria./api/v2/leads/source-locationsPOSTCreates a new lead./api/v2/leadsPOSTCreates a new lead from external source./api/v2/leads/externalPOSTCreates a new lead against company./api/v2/leads/against-companyPUTUpdates an existing lead against company by its ID./api/v2/leads/against-company/{leadId}POSTPOST /api/v2/leads/{leadId}/acknowledge/api/v2/leads/{leadId}/acknowledgeGETFetches a note by its ID.
/api/v2/notes/{noteId}DELETEDeletes a note by its ID./api/v2/notes/{noteId}PUTUpdates an existing note by its ID./api/v2/notes/{noteId}POSTAdds a new note./api/v2/notesGETFetches a list of notes based on the provided query parameters./api/v2/notesGETFetches all available note types./api/v2/notes/typesGETFetches available note purposes for the current user./api/v2/notes/purposesGETFetches note results associated with specified purpose IDs./api/v2/notes/results-by-purposesGETFetches notes related to a specific record with pagination./api/v2/notes/by-recordGETFetches opportunity statuses.
/api/v2/opportunities/statusesGETFetches opportunity sale types./api/v2/opportunities/sale-typesGETFetches opportunity assigned reasons./api/v2/opportunities/reasonsGETFetches known opportunity competitors./api/v2/opportunities/competitorsPOSTCreates a new competitor./api/v2/opportunities/competitorsGETFetches competitor by ID./api/v2/opportunities/competitors/{competitorId}DELETEDeletes a competitor./api/v2/opportunities/competitors/{competitorId}PUTUpdates an existing competitor./api/v2/opportunities/competitors/{competitorId}GETFetches opportunity transaction types./api/v2/opportunities/transaction-typesGETFetches all configured opportunity fields./api/v2/opportunities/fieldsGETFetches all opportunity groups./api/v2/opportunities/groupsGETFetches a list of opportunities with filtering, sorting, and pagination options./api/v2/opportunities/listGETFetches opportunity by ID./api/v2/opportunities/{opportunityId}PUTUpdates an existing opportunity./api/v2/opportunities/{opportunityId}DELETEDeletes an opportunity./api/v2/opportunities/{opportunityId}POSTCreates a new opportunity./api/v2/opportunitiesPOSTRetrieves a paginated SalesQuote report filtered by any combination of the supplied criteria.
/api/v2/reporting/sales-quotesPOSTRetrieves a paginated Lead report filtered by any combination of the supplied criteria./api/v2/reporting/leadsPOSTRetrieves a Company report filtered by any combination of the supplied criteria./api/v2/reporting/companiesGETRetrieves a paginated, searchable lookup list of branches for use in report filter UIs./api/v2/reporting/lookups/branchesGETRetrieves a paginated, searchable lookup list of users for use in report filter UIs./api/v2/reporting/lookups/usersGETRetrieves a paginated, searchable lookup list of sales quote statuses for use in report filter UIs./api/v2/reporting/lookups/sales-quote-statusesGETRetrieves a paginated, searchable lookup list of lead statuses for use in report filter UIs./api/v2/reporting/lookups/lead-statusesGETRetrieves a paginated, searchable lookup list of lead sources for use in report filter UIs./api/v2/reporting/lookups/lead-sourcesGETRetrieves a paginated, searchable lookup list of company categories for use in report filter UIs./api/v2/reporting/lookups/company-categoriesGETRetrieves a paginated, searchable lookup list of company ranks for use in report filter UIs./api/v2/reporting/lookups/company-ranksGETRetrieves a list of active sales quotes based on the specified filter.
/api/v2/sales-quote/activeGETRetrieves a list of active sales quotes based on the specified search parameters./api/v2/sales-quote/listGETGET /api/v2/sales-quote/manufacturers/api/v2/sales-quote/manufacturersGETGET /api/v2/sales-quote/models/api/v2/sales-quote/modelsGETGets sales quote details by ID./api/v2/sales-quote/{salesQuoteId}POSTSubmits customer decision on a sales quote./api/v2/sales-quote/decisionPOSTReverses the most recent decision made on the specified sales quote./api/v2/sales-quote/{salesQuoteId}/decision/undoGETRetrieves the list of documents associated with the specified sales quote./api/v2/sales-quote/{salesQuoteId}/documentsGETRetrieves the list of equipment associated with the specified sales quote./api/v2/sales-quote/{salesQuoteId}/equipmentGETDownloads the specified document associated with a sales quote./api/v2/sales-quote/{salesQuoteId}/documents/{documentId}/downloadGETDownloads the deal sheet file associated with the specified sales quote./api/v2/sales-quote/{salesQuoteId}/deal-sheet/downloadPOSTSubmits an approval decision for a sales quote request./api/v2/sales-quote/submit-approval-decisionSales Quote Requests
POSTPOST /api/v2/sales-quote/sales-quote-request
/api/v2/sales-quote/sales-quote-requestPUTUpdates an existing sales quote request./api/v2/sales-quote/sales-quote-request/{requestId}DELETEDeletes a sales quote request by ID./api/v2/sales-quote/sales-quote-request/{requestId}GETGets sales quote request details by id./api/v2/sales-quote/sales-quote-request/{requestId}GETFetches all lease types needed for sales quote request creation/update./api/v2/sales-quote/sales-quote-request/lease-typesGETFetches all finance terms needed for sales quote request creation/update./api/v2/sales-quote/sales-quote-request/finance-termsGETFetches either warranty, warranty months, or warranty hours lookup data based on make needed for sales quote request creation/update./api/v2/sales-quote/sales-quote-request/lookup-dataPOSTAcknowledges an existing sales quote request./api/v2/sales-quote/sales-quote-request/acknowledgePOSTCompletes an existing sales quote request./api/v2/sales-quote/sales-quote-request/completeGETReturns a list of sales quote requests from the current user's access level with available filters
being AllOpen, AllUnacknowledged, AllComplete, and AllRequests./api/v2/sales-quote/sales-quote-request/listGETFetches a task by its ID.
/api/v2/tasks/{taskId}DELETEDeletes a task by its ID./api/v2/tasks/{taskId}GETFetches all available task statuses./api/v2/tasks/statusesGETFetches all available task priorities./api/v2/tasks/prioritiesGETFetches tasks related to a specific record with pagination./api/v2/tasks/by-recordPOSTAdds a new task./api/v2/tasksPUTUpdates an existing task by its ID./api/v2/tasks/{task-id}POSTMarks a task as completed./api/v2/tasks/complete/{taskId}POSTCreate bulk tasks for list of equipment from a single company./api/v2/tasks/bulk-assign