WORKPILOT API Help Page

Introduction

To learn more about the WORKPILOT API - please contact us.

ClientSetting

API	Description
GET api/v1/client-settings/by-clientid/{clientId}	Get a list of client settings for a specific client
GET api/v1/client-settings/colors	Get a list of colors to style the client
GET api/v1/client-settings/labels/{clientId}	Get a list of labels based on user language and customer template
POST api/ClientSetting	No documentation available.
POST api/ClientSetting?wpCustomerId={wpCustomerId}&documentId={documentId}	No documentation available.

Milestone

API	Description
GET api/v1/{wpCustomerId}/milestones/check-and-send-notifications	Checks if any milestones have notifications that needs to be sent out to the responsible users.
POST api/Milestone	No documentation available.
POST api/Milestone?wpCustomerId={wpCustomerId}&documentId={documentId}	No documentation available.

TimeRegistration

API	Description
GET api/v1/time-registrations/cases	Get a list of Cases for TimeRegistration, which are cases with the value .ShowInTimeReg set to true.
GET api/v1/time-registrations/dates/{date}	Get time registrations for a date.
GET api/v1/time-registrations/for-current-user/dates/{date}	Get time registrations for the current user for a date.
GET api/v1/time-registrations/for-current-user/dates/{startDate}/{endDate}	Get time registrations for the current user for a date.
GET api/v1/time-registrations/cases/{caseId}/dates/{date}	Get timeregistrations for a Case and a date
GET api/v1/time-registrations/{timeRegistrationId}	Get a TimeRegistration by TimeRegistrationId
GET api/v1/expense-types	Get a list of ExpenseTypes. Used when attaching Expenses to TimeRegistrations.
POST api/v1/time-registrations/list	Used to post a list of timeregistration objects. Attempts to create as many of the posted items as possible. Returns an object with a list of succesful creates and failed creates.
POST api/v1/time-registrations	Used to post a single timeregistration object
GET api/v1/timeregistration-types	Used to retrieve timeregistration types
POST api/TimeRegistration	No documentation available.
POST api/TimeRegistration?wpCustomerId={wpCustomerId}&documentId={documentId}	No documentation available.

File

API	Description
GET api/v1/files?hasNoBindings={hasNoBindings}	Get files for a workpilot customer
GET api/v1/files/updated-since/{date}-{hours}-{minutes}?hasNoBindings={hasNoBindings}	Get a list of Files, that are updated since the provided datetime object, and a list of FileIds of Filess deleted since the provided datetime object. Example date and time: yyyy-MM-dd-HH-mm.
GET api/v1/files/types/{fileTypeId}	Returns a list of files for a WP_Customer, of a given file type
GET api/v1/files/{fileId}	Get a File by FileId
POST api/File	No documentation available.
POST api/File?wpCustomerId={wpCustomerId}&documentId={documentId}	No documentation available.

Mail

API	Description
POST api/v1/mails	Create a new Mail with attachments for the API to send.
GET api/v1/mails/signatures	No documentation available.
POST api/Mail	No documentation available.
POST api/Mail?wpCustomerId={wpCustomerId}&documentId={documentId}	No documentation available.

Customer

API	Description
GET api/v1/customers	Get a list of customer, including adress information and contact persons.
POST api/v1/customer	Create a new customers
GET api/v1/customers/{customerId}/cases/closed-cases	No documentation available.
POST api/Customer	No documentation available.
POST api/Customer?wpCustomerId={wpCustomerId}&documentId={documentId}	No documentation available.

ContactPerson

API	Description
POST api/v1/contact-person	Create a new contact person
PUT api/v1/contact-person	Edit a contact person
DELETE api/v1/contact-person/{Id}	Delete a contact person
POST api/ContactPerson	No documentation available.
POST api/ContactPerson?wpCustomerId={wpCustomerId}&documentId={documentId}	No documentation available.

Case

API	Description
GET api/v1/cases	Get a list of Case objects that are not completed or deleted
GET api/v1/cases/{caseId}	Get a Case by CaseId
GET api/v1/cases/by-case-number/{caseNumber}	Get a Case object. Contains information about a case, as well as a Customer object, a ContactInformation object and a list of tasks to perform for the case.
GET api/v1/cases/updated-since/{date}-{hours}-{minutes}?shallow={shallow}	Get a list of Cases for the current user, that are updated since the provided datetime object, and a list of CaseIds of Cases deleted since the provided datetime object. Example date and time: yyyy-MM-dd-HH-mm.
GET api/v1/cases/{caseId}/files	Get a list of Files assigned to a Case.
GET api/v1/cases/{caseId}/files/{fileId}	Get a File assigned to a Case.
POST api/v1/cases/{caseId}/file-bindings	Creates a new CaseFileBinding. Used to assign a File to a Case.
PUT api/v1/cases/{caseId}/file-bindings/{caseFileBindingId}	Updates an existing CaseFileBinding.
DELETE api/v1/cases/{caseId}/file-bindings/{caseFileBindingId}	Deletes a CaseFileBinding.
GET api/v1/cases/checklist	Get the Case Checklist
PATCH api/v1/cases/{caseId}/update-completed-for-current-user/{isCompleted}	Used to set status completed on a case for the current user. If all users assigned to a case set their status to closed, the case is also closed.
PATCH api/v1/cases/{caseId}/accept-case-for-current-user	No documentation available.
PATCH api/v1/cases/{caseId}/update-case-status-for-current-user	No documentation available.
GET api/v1/cases/status-types	Get a list of CaseStatusTypes.
POST api/v1/cases	Create a new Case.
DELETE api/v1/cases/{caseId}	Delete case.
PUT api/v1/cases/{caseId}	Update information for an existing Case.
GET api/v1/{wpCustomerId}/cases/update-from-external-provider	No documentation available.
GET api/v1/{wpCustomerId}/cases/update-from-external-provider/{externalNumber}	No documentation available.
POST api/Case	No documentation available.
POST api/Case?wpCustomerId={wpCustomerId}&documentId={documentId}	No documentation available.

User

User controller. Performs actions for User objects

API	Description
GET api/v1/users	Get a list of users, including contact information and geolocation.
GET api/v1/users/current-user	No documentation available.
GET api/v1/users/manage-users	No documentation available.
GET api/v1/users/manage-users/{userId}	No documentation available.
POST api/v1/geo-locations/for-current-user	Updates geolocation for current user
GET api/v1/{wpCustomerId}/users/update-from-external-provider	No documentation available.
POST api/v1/users/{userId}/login	No documentation available.
DELETE api/v1/users/{userId}/login	No documentation available.
POST api/User	No documentation available.
POST api/User?wpCustomerId={wpCustomerId}&documentId={documentId}	No documentation available.

Image

API	Description
GET api/v1/images	Get a list of Images
GET api/v1/images/{imageId}	Get an Image by ImageId
POST api/v1/images	Upload a new Image
PUT api/v1/images/{imageId}	Update an existing Image
GET api/v1/image-groups?caseId={caseId}	Get a list of ImageGroups
GET api/v1/cases/{caseId}/image-groups	Get a list of ImageGroups
GET api/v1/image-groups/{imageGroupId}?caseId={caseId}	Get an ImageGroup by ImageGroupId
GET api/v1/cases/{caseId}/image-groups/{imageGroupId}	Get an ImageGroup by ImageGroupId
POST api/v1/image-groups	Create a new ImageGroup
PUT api/v1/image-groups/{imageGroupId}	Update an existing ImageGroup
POST api/v1/groups-with-images	Create groups and images
POST api/Image	No documentation available.
POST api/Image?wpCustomerId={wpCustomerId}&documentId={documentId}	No documentation available.

Product

API	Description
GET api/v1/products?searchString={searchString}&rowLimit={rowLimit}	Get a list of Products based on a searchstring. Does not implement pagination, only limit on rows returned.
GET api/v1/products?pageNumber={pageNumber}&searchString={searchString}&rowLimit={rowLimit}	Get a list of products. Implements pagination.
GET api/v1/products/cases/{caseId}?isShallow={isShallow}	Get a list of Products for a CaseId
GET api/v1/products/{productId}?includeRegistrations={includeRegistrations}	Get a Product by ProductId
GET api/v1/products/by-ean-number/{eanNumber}	No documentation available.
POST api/v1/products/by-ean-number	No documentation available.
POST api/v1/products/by-product-id	No documentation available.
PUT api/v1/products/product-registrations/{productRegistrationId}	Update an existing ProductRegistration
POST api/v1/products/product-registrations	Create a number of new ProductRegistrations. If a productId is supplied, the registration is made for an existing product. Otherwise, a new custom product is created for the WP_Customer, and the registration is made for this product. Also, a ProductRegistration can be either a credit or debit registration.
GET api/v1/products/product-registrations/{productRegistrationId}	Get a ProductRegistration by ProductRegistrationId
POST api/v1/products/test-solar-products	No documentation available.
GET api/v1/products/test-update-from-solar	No documentation available.
GET api/v1/{wpCustomerId}/products/update-from-external-provider?supplierId={supplierId}	No documentation available.
GET api/v1/{wpCustomerId}/products/update-from-external-provider/{externalNumber}	No documentation available.
GET api/v1/{wpCustomerId}/product-groups/update-from-external-provider	No documentation available.
GET api/v1/{wpCustomerId}/product-groups/update-from-external-provider/{externalNumber}	No documentation available.
POST api/Product	No documentation available.
POST api/Product?wpCustomerId={wpCustomerId}&documentId={documentId}	No documentation available.

Template

API	Description
GET api/v1/templates?shallow={shallow}	Get a list of Templates
GET api/v1/templates/{templateId}?shallow={shallow}	Get a Template by TemplateId
GET api/v1/templates/updated-since/{date}-{hours}-{minutes}?isShallow={isShallow}	Get a list of Templates updated since a date and time. Example date and time: yyyy-MM-dd-HH-mm.
POST api/Template	No documentation available.
POST api/Template?wpCustomerId={wpCustomerId}&documentId={documentId}	No documentation available.

Utility

API	Description
GET api/v1/utility/server-time	Get the current server time
GET api/v1/utility/server-ping/{wpCustomerId}	returns the time to retrieve a simple data object from WP and External DB (if present)
GET api/v1/utility/country-select-list	Get the country list
POST api/Utility	No documentation available.
POST api/Utility?wpCustomerId={wpCustomerId}&documentId={documentId}	No documentation available.

Document

API	Description
GET api/v1/documents	Get a list of Documents
GET api/v1/documents/{documentId}?isShallow={isShallow}	Get a Document by DocumentId
GET api/v1/documents/by-case-id/{caseId}	Get Documents by CaseId
GET api/v1/documents/updated-since/{date}-{hours}-{minutes}?isShallow={isShallow}	Returns documents updated since datetime object provided in the uri. Datetime object must be of form yyyy-mm-dd-hh-mm.
PUT api/v1/documents/{documentId}	Updates a Document.
POST api/v1/documents	Create a new Document
DELETE api/v1/documents/{documentId}	Delete a Document.
POST api/Document	No documentation available.
POST api/Document?wpCustomerId={wpCustomerId}&documentId={documentId}	No documentation available.

Project

API	Description
GET api/v1/projects	Get a list of projects
GET api/v1/project/types	Get a list of project types
GET api/v1/project/statuses	Get a list of project statuses
POST api/v1/project	Create a new project
POST api/Project	No documentation available.
POST api/Project?wpCustomerId={wpCustomerId}&documentId={documentId}	No documentation available.

Application

API	Description
POST api/Application	No documentation available.
POST api/Application?wpCustomerId={wpCustomerId}&documentId={documentId}	No documentation available.