developer notes

Get All Projects By Site

The ProjectsGetAllBySite API allows you to retrieve all existing Projects by Site.

Method	API Endpoint
GET	`{{endpoint}}/api/ext/projects`

‍

Headers

‍

Key	Value
Content-Type	`application/json`
Authorization	`Bearer {{token}}`

‍

Filter Fields

‍

Parameter	Type	Example	Required	Description
page	Number	0	true	Specifies the page number
perPage	Number	25	true	Specifies the number of records per page
startFrom	Number	0	true	Specifies the start point of the column being sorted
columnName	String	id	true	Specifies the name of the column being sorted
sortOrder	String	desc/asc	true	Specifies the order in which the column is being sorted
search	String	a	true	Specifies the search query
customerId	Number	1	false	Customer ID for filtering
projectType	Number	1	false	Project Type for filtering
serviceZoneId	Number	2	false	Service Zone ID for filtering
categoryId	Number	1	false	Category ID for filtering
geofenceId	Number	1	false	Geofence ID for filtering
siteId	Number	1	false	Site ID for filtering
origin	String	project	false	Origin information for filtering

‍

API Query Example

‍

Method	API Call
GET	`api/ext/projects? page=1&perPage=2&startFrom=3&columnName=id&sortOrder =desc&search=a&customerId=15&projectType=1&serviceZoneId =1&categoryId=1&geofenceId=1&siteId=1&origin=customer`

‍

Example Response

‍

// 200 Response Code
{
    "total": 0,
    "count": 2,
    "data": [],
    "recordsTotal": 0,
    "recordsFiltered": 0,
    "status": "SEARCH_NO_RESULTS"
}

‍