Endpoint
/api/v2/tenants/{tenantId}/sites/search
Path Parameters
tenantId
string

Describes the client ID of the tenant

Query Parameters
pageNo
integer

pageSize
integer

isDescendingOrder
boolean

sortName
string

queryString
string

Responses

OK

descendingOrder
boolean

nextPage
boolean

orderBy
string

pageNo
integer

pageSize
integer

previousPageNo
integer

results
array

results.address
(Optional) Site address.
results.city
(Optional) Site city.
results.clientId
results.country
results.description
(Optional) Summary of the site.
results.devices
results.filterCriteria
results.id
results.mspId
results.name
Site name.
results.parent
(Optional) Parent site. Required if creating a sub-site under a parent site:
results.phoneExtension
(Optional) Site phone extension number.
results.phoneNumber
(Optional) Site phone number for communication.
results.primaryContact
results.resources
results.state
(Optional) Site state.
results.zip
(Optional) Zip code.
totalPages
integer

totalResults
integer

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