ServiceTrade
Field service management API for commercial contractors
| API | Protocol | Base URL | Docs | Reference | OpenAPI | SDKs |
|---|---|---|---|---|---|---|
| Main | rest | https://api.servicetrade.com/api | link | — | — | — |
Actions (234)
Asset · 11
- Create assetPOST /asset
Create a new asset.
documented - Delete assetDELETE /asset/{assetId}
Delete an asset.
documented - Enable group tasking on assetPOST /asset/{assetId}/enablegrouptasking
Enable group tasking for an abstract asset group.
documented - List assetsGET /asset
Return assets matching query parameters (locationId, etc.).
documented - List deficiencies for assetGET /asset/{assetId}/deficiency
List deficiencies for a specific asset.
documented - Report deficiency for assetPOST /asset/{assetId}/deficiency
Report a deficiency for an asset.
documented - Report deficiency for assetPOST /asset/{assetId}/deficiency
Report a deficiency against an asset.
documented - Retrieve assetGET /asset/{assetId}
Retrieve a single asset by ID.
documented - Retrieve deficiency for assetGET /asset/{assetId}/deficiency/{deficiencyId}
Retrieve a single deficiency for an asset.
documented - Swap asset definitionPUT /asset/{assetId}/definition
Associate a different asset definition with an existing asset.
documented - Update assetPUT /asset/{assetId}
Update an existing asset.
documented
Service Item · 8
- Create service itemPOST /servicerequest/{serviceRequestId}/item
Create a new service item for a service request.
documented - Create service item (standalone)POST /serviceitem
Create a new service item.
documented - Delete service itemDELETE /serviceitem/{itemId}
Delete a service item.
documented - List service items for service requestGET /servicerequest/{serviceRequestId}/item
List items for a service request.
documented - Retrieve service itemGET /servicerequest/{serviceRequestId}/item/{itemId}
Retrieve an item for a given service request.
documented - Retrieve service item by IDGET /serviceitem/{itemId}
Retrieve a service item by ID.
documented - Update service itemPUT /servicerequest/{serviceRequestId}/item/{itemId}
Update a service item.
documented - Update service item by IDPUT /serviceitem/{itemId}
Update a service item by ID.
documented
Attachment · 7
- Delete attachmentDELETE /attachment/{attachmentId}
Delete an attachment.
documented - List attachmentsGET /attachment
List attachments (with optional filters such as entityId/entityType).
documented - Retrieve attachmentGET /attachment/{attachmentId}
Retrieve a specific attachment.
documented - Retrieve attachment thumbnailGET /attachment/{attachmentId}/thumbnail
Retrieve thumbnail for an attachment.
documented - Update attachmentPOST /attachment/{attachmentId}
Update an attachment.
documented - Update attachment (PUT)PUT /attachment/{attachmentId}
Update an attachment (alternative method).
documented - Upload attachmentPOST /attachment
Upload a new attachment.
documented
Budget · 6
- Create budgetPOST /budget
Create a new budget for a job.
documented - List budgetsGET /budget
List budgets (optionally filtered by jobId or referenceNumber).
documented - Retrieve budgetGET /budget/{budgetId}
Retrieve a specific budget.
documented - Revise budgetPOST /budget/{budgetId}/revise
Revise a budget (create a new version).
documented - Revise budget with change orderPOST /budget/{budgetId}/revise
Revise a budget while applying a change order.
documented - Update budgetPUT /budget/{budgetId}
Update an existing budget.
documented
Appointment · 5
- Create appointmentPOST /appointment
Create a new appointment for a job/location.
documented - Delete appointmentDELETE /appointment/{appointmentId}
Delete an appointment.
documented - List appointmentsGET /appointment
List appointments (by filters) for the account.
documented - Retrieve appointmentGET /appointment/{appointmentId}
Retrieve a single appointment by ID.
documented - Update appointmentPUT /appointment/{appointmentId}
Update an existing appointment.
documented
Budget Category · 5
- Create budget categoryPOST /budgetcategory
Create a new budget category.
documented - Delete budget categoryDELETE /budgetcategory/{budgetCategoryId}
Delete a budget category.
documented - List budget categoriesGET /budgetcategory
List budget categories.
documented - Retrieve budget categoryGET /budgetcategory/{budgetCategoryId}
Get a budget category by ID.
documented - Update budget categoryPUT /budgetcategory/{budgetCategoryId}
Update an existing budget category.
documented
Budget Line Item · 5
- Create budget line itemPOST /budgetlineitem
Create a new budget line item.
documented - Delete budget line itemDELETE /budgetlineitem/{budgetLineItemId}
Delete a budget line item.
documented - List budget line itemsGET /budgetlineitem
List budget line items.
documented - Retrieve budget line itemGET /budgetlineitem/{budgetLineItemId}
Retrieve a specific budget line item.
documented - Update budget line itemPUT /budgetlineitem/{budgetLineItemId}
Update an existing budget line item.
documented
Change Order · 5
- Create change orderPOST /changeorder
Create a new change order.
documented - Delete change orderDELETE /changeorder/{changeOrderId}
Delete a change order.
documented - List change ordersGET /changeorder
List change orders.
documented - Retrieve change orderGET /changeorder/{changeOrderId}
Retrieve a change order by ID.
documented - Update change orderPUT /changeorder/{changeOrderId}
Update an existing change order.
documented
Change Order Category · 5
- Create change order categoryPOST /changeordercategory
Create a new change order category.
documented - Delete change order categoryDELETE /changeordercategory/{id}
Delete a change order category.
documented - List change order categoriesGET /changeordercategory
List change order categories.
documented - Retrieve change order categoryGET /changeordercategory/{id}
Retrieve a specific change order category.
documented - Update change order categoryPUT /changeordercategory/{id}
Update a change order category.
documented
Change Order Line Item · 5
- Create change order line itemPOST /changeorderlineitem
Create a new change order line item.
documented - Delete change order line itemDELETE /changeorderlineitem/{id}
Delete a change order line item.
documented - List change order line itemsGET /changeorderlineitem
List change order line items.
documented - Retrieve change order line itemGET /changeorderlineitem/{id}
Retrieve a change order line item.
documented - Update change order line itemPUT /changeorderlineitem/{id}
Update an existing change order line item.
documented
Clockin/Clockout · 5
- Create clock eventPOST /clock
Create a clock-in or clock-out event.
documented - Delete clock eventDELETE /clock/{clockId}
Delete a clock event.
documented - List clock eventsGET /clock
List clock events with optional filters.
documented - Retrieve clock eventGET /clock/{clockId}
Retrieve a specific clock event.
documented - Update clock eventPUT /clock/{clockId}
Update an existing clock event.
documented
Comment · 5
- Create commentPOST /comment
Create a new comment.
documented - Delete commentDELETE /comment/{commentId}
Delete a comment.
documented - List commentsGET /comment
List comments for an entity.
documented - Retrieve commentGET /comment/{commentId}
Retrieve a single comment by ID.
documented - Update commentPUT /comment/{commentId}
Update an existing comment.
documented
Contact · 5
- Create contactPOST /contact
Create a new contact.
documented - Delete contactDELETE /contact/{contactId}
Delete a contact.
documented - List contactsGET /contact
List contacts.
documented - Retrieve contactGET /contact/{contactId}
Retrieve a single contact by ID.
documented - Update contactPUT /contact/{contactId}
Update a contact.
documented
Group Label · 5
- Create group labelPOST /grouplabel
Create a new group label.
documented - Delete group labelDELETE /grouplabel/{groupLabelId}
Delete a group label.
documented - List group labelsGET /grouplabel
List group labels.
documented - Retrieve group labelGET /grouplabel/{groupLabelId}
Retrieve a group label by ID.
documented - Update group labelPUT /grouplabel/{groupLabelId}
Update an existing group label.
documented
Job · 5
Location · 5
- Create locationPOST /location
Create a new location.
documented - Delete locationDELETE /location/{locationId}
Delete a location.
documented - List locationsGET /location
List locations.
documented - Retrieve locationGET /location/{locationId}
Retrieve a location by ID.
documented - Update locationPUT /location/{locationId}
Update a location.
documented
Time Card · 5
- Create time cardPOST /timecard
Create a time card.
documented - Delete time cardDELETE /timecard/{timeCardId}
Delete a time card.
documented - List time cardsGET /timecard
List time cards.
documented - Retrieve time cardGET /timecard/{timeCardId}
Retrieve a time card by ID.
documented - Update time cardPUT /timecard/{timeCardId}
Update a time card.
documented
User · 5
Asset Definition · 4
- List asset definitionsGET /assetdefinition
List asset definitions (optionally filtered by type).
documented - Retrieve asset definition by IDGET /assetdefinition/{id}
Retrieve a single asset definition by ID.
documented - Retrieve asset definition by typeGET /assetdefinition/{type}
Retrieve asset definitions for a given type.
documented - Retrieve asset definitions by locationGET /assetdefinition/location
Retrieve definitions relevant to a location.
documented
Brand · 4
- Create brandPOST /company/{companyId}/brand
Create a new brand for a company.
documented - List brands for companyGET /company/{companyId}/brand
List brands for a company.
documented - Retrieve brandGET /company/{companyId}/brand/{brandId}
Retrieve a single brand.
documented - Update brandPUT /company/{companyId}/brand/{brandId}
Update an existing brand.
documented
Company · 4
Contract · 4
ExternalId · 4
- Create external IDPOST /externalid/{entityType}/{entityId}/{externalSystem}
Create an external ID for an entity and external system.
documented - Retrieve external IDGET /externalid/{entityType}/{entityId}
Retrieve external IDs for an entity.
documented - Retrieve external ID by systemGET /externalid/{entityType}/{entityId}/{externalSystem}
Retrieve an external ID for an entity and external system.
documented - Update external IDPUT /externalid/{entityType}/{entityId}/{externalSystem}
Update an external ID for an entity.
documented
Invoice · 4
Invoice Item · 4
- Create invoice itemPOST /invoiceitem
Create a new invoice item.
documented - List invoice itemsGET /invoiceitem
List invoice items.
documented - Retrieve invoice itemGET /invoiceitem/{invoiceItemId}
Retrieve an invoice item by ID.
documented - Update invoice itemPUT /invoiceitem/{invoiceItemId}
Update an invoice item.
documented
LibItem · 4
Quote · 4
Quote Item · 4
Quote Template · 4
- Create quote templatePOST /quotetemplate
Create a quote template.
documented - List quote templatesGET /quotetemplate
List quote templates.
documented - Retrieve quote templateGET /quotetemplate/{quotaTemplateId}
Retrieve a quote template by ID.
documented - Update quote templatePUT /quotetemplate/{quotaTemplateId}
Update a quote template.
documented
Authentication · 3
- Create authentication sessionPOST /auth
Create a new authentication session by posting credentials. Returns an auth token and user context.
documented - End authentication sessionDELETE /auth
End the current authentication session.
documented - Retrieve authentication sessionGET /auth
Retrieve the current authentication session (or confirm an active session).
documented