getProjects

Returns an array of projects.

Input parameters

Parameter name Description Possible value Required
projectID Project ID. integer
customerID Customer ID. integer
typeID Project type ID, see getProjectTypes. integer
statusID Project status ID, see getProjectStatuses. integer
name Retrieve by name that starts with the provided value. string
startDateFrom ISO date (yyyy-mm-dd)
startDateTo ISO date (yyyy-mm-dd)
endDateFrom ISO date (yyyy-mm-dd)
endDateTo ISO date (yyyy-mm-dd)
changedSince Retrieve only items that have been added or modified since the specified timestamp. Use it to keep a local database in sync with Erply. Integer (Unix timestamp)
recordsOnPage Number of records API should return. By default 20, at most 100. integer
pageNo API returns at most recordsOnPage items at a time. To retrieve the next recordsOnPage items, send a new request with pageNo incremented by one. By default, API returns "page 1". integer

Response

Field name Type Description
projectID integer Project ID.
name string Project name.
customerID integer Customer ID.
customerName string Customer name.
employeeID integer Project manager ID.
employeeName string Name of project manager.
typeID integer Project type ID.
typeName string Name of project type.
statusID integer Project status ID.
statusName string Name of project status.
startDate ISO date (yyyy-mm-dd)
endDate ISO date (yyyy-mm-dd)
notes string Notes.
lastModified Unix timestamp.