Documentation is now available for the Fall 2020 Update release!

Search sites

This endpoint is used to search sites.

Leave Feedback

URL

GET https://{api-url}/api/v2/tenants/{tenantId}/sites/search

Sample URLs

https://{api-url}/api/v2/tenants/client_69856/sites/search?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=id&queryString=id:45+name:east-zone+parentId:20
https://{api-url}/api/v2/tenants/msp_6/sites/search?pageNo=1&pageSize=10&isDescendingOrder=true&sortName=id&queryString=id:31+name:east-zone+parentId:30

Parameters

FieldDefault Value
pageNo={pageNo}1
pageSize={pageSize}100
isDescendingOrder={true/false}true
sortName={field}id
queryString={queryString}NA

NA indicates that the value is not applicable.

Query variables

Query VariablesDescription
idSite unique id.
nameSite name.
parentIdParent side ID.

Sample response

{
	"results": [{
			"id": 31,
			"name": "SJ-EAST",
			"description": "Resources in east zone",
			"address": "5th Avenue, Parkway",
			"zip": "94088",
			"phoneNumber": "406-232-1234",
			"phoneExtension": "1",
			"primaryContact": {
				"id": "USR0000000014",
				"loginName": "InsLab@organization.com",
				"lastName": "Lab",
				"firstName": "Ins",
				"email": "john.smith@gmail.com",
				"phoneNumber": "406-625-1234"
			}
		},
		{
			"id": 11,
			"name": "SJ-North East",
			"description": "Resources in North East zone",
			"address": "",
			"primaryContact": {
				"id": "USR0000000014",
				"loginName": "InsLab@organization.com",
				"lastName": "Lab",
				"firstName": "Ins",
				"email": "john.smith@gmail.com",
				"phoneNumber": "408-625-1234"
			}
		},
		{
			"id": 8,
			"name": "SJ-WEST",
			"description": "Resources in West zone",
			"address": "Vizag",
			"primaryContact": {
				"id": "USR0000000014",
				"loginName": "InsLab@agency.com",
				"lastName": "Lab",
				"firstName": "Ins",
				"email": "john.smith@gmail.com",
				"phoneNumber": "523-625-2345"
			}
		},
		{
			"id": 6,
			"name": "SJ-South West",
			"description": "Resources in south west zone",
			"address": "WEST-ZONE"
		},
		{
			"id": 5,
			"name": "SJ-NORTH",
			"description": "Resources in North zone",
			"address": "Blossom Valley",
			"phoneNumber": "406-746-2344",
			"primaryContact": {
				"id": "USR0000000014",
				"loginName": "InsLab@organization.com",
				"lastName": "Lab",
				"firstName": "Ins",
				"email": "david.henry@gmail.com",
				"phoneNumber": "406-625-4567"
			}
		},
		{
			"id": 4,
			"name": "SJ-SOUTH",
			"description": "Resources in South zone",
			"address": "Pink Valley",
			"primaryContact": {
				"id": "USR0000000014",
				"loginName": "InsLab@company.com",
				"lastName": "Lab",
				"firstName": "Ins",
				"email": "henry.williams@gmail.com",
				"phoneNumber": "809-625-2345"
			}
		},
		{
			"id": 3,
			"name": "SJ-CENTRAL",
			"description": "Primary site for the east zone",
			"address": "Central Valley",
			"primaryContact": {
				"id": "USR0000000014",
				"loginName": "sj.central@institution.com",
				"lastName": "Smith",
				"firstName": "John",
				"email": "john.smith@gmail.com",
				"phoneNumber": "809-625-2233"
			}
		},
		{
			"id": 2,
			"name": "SJ-MAIN",
			"description": "High priority site",
			"address": "Parkway",
			"primaryContact": {
				"id": "USR0000000014",
				"loginName": "InsLab@institution.com",
				"lastName": "Lab",
				"firstName": "Main",
				"email": "john.smith@gmail.com",
				"phoneNumber": "809-625-1234"
			}
		}
	],
	"totalResults": 9,
	"orderBy": "id",
	"pageNo": 1,
	"pageSize": 10,
	"totalPages": 1,
	"nextPage": false,
	"previousPageNo": 0,
	"descendingOrder": true
}