Skip to main content
GET
/
api
/
Sites
/
{siteId}
Retrieve a single Site.
curl --request GET \
  --url https://api.example.com/api/Sites/{siteId}
{
  "id": 123,
  "clientID": 123,
  "name": "<string>",
  "clientName": "<string>",
  "address1": "<string>",
  "address2": "<string>",
  "address3": "<string>",
  "suburb": "<string>",
  "state": "<string>",
  "postcode": "<string>",
  "country": "<string>",
  "countryName": "<string>",
  "createdById": 123,
  "createdByName": "<string>",
  "updatedById": 123,
  "updatedByName": "<string>",
  "statusID": 123,
  "status": "<string>",
  "contacts": 123,
  "createdDate": "2023-11-07T05:31:56Z",
  "updatedDate": "2023-11-07T05:31:56Z",
  "phone": "<string>",
  "primaryContact": 123,
  "primaryContactName": "<string>",
  "primaryContactFirstName": "<string>",
  "primaryContactLastName": "<string>",
  "primaryContactEmail": "<string>",
  "primaryContactOptOut": "<string>",
  "phoneStandardised": "<string>",
  "description": "<string>",
  "tags": true,
  "customField1": "<string>",
  "customField2": "<string>",
  "customField3": "<string>",
  "customField4": "<string>",
  "customField5": "<string>",
  "customField6": "<string>",
  "customField7": "<string>",
  "customField8": "<string>",
  "customField9": "<string>",
  "customField10": "<string>",
  "customField11": 123,
  "customField12": 123,
  "customField13": 123,
  "customField14": 123,
  "customField15": 123,
  "customField16": "2023-11-07T05:31:56Z",
  "customField17": "2023-11-07T05:31:56Z",
  "customField18": "2023-11-07T05:31:56Z",
  "customField19": "2023-11-07T05:31:56Z",
  "customField20": "2023-11-07T05:31:56Z",
  "customField21": "<string>",
  "customField22": "<string>",
  "customField23": "<string>",
  "customField24": "<string>",
  "customField25": "<string>",
  "customField26": "<string>",
  "customField27": "<string>",
  "customField28": "<string>",
  "customField29": "<string>",
  "customField30": "<string>",
  "customField31": 123,
  "customField32": 123,
  "customField33": 123,
  "customField34": 123,
  "customField35": 123,
  "customField36": "2023-11-07T05:31:56Z",
  "customField37": "2023-11-07T05:31:56Z",
  "customField38": "2023-11-07T05:31:56Z",
  "customField39": "2023-11-07T05:31:56Z",
  "customField40": "2023-11-07T05:31:56Z",
  "customField41": "<string>",
  "customField42": "<string>",
  "customField43": "<string>",
  "customField44": "<string>",
  "customField45": "<string>",
  "customField46": "<string>",
  "customField47": "<string>",
  "customField48": "<string>",
  "customField49": "<string>",
  "customField50": "<string>",
  "customField51": 123,
  "customField52": 123,
  "customField53": 123,
  "customField54": 123,
  "customField55": 123,
  "customField56": "2023-11-07T05:31:56Z",
  "customField57": "2023-11-07T05:31:56Z",
  "customField58": "2023-11-07T05:31:56Z",
  "customField59": "2023-11-07T05:31:56Z",
  "customField60": "2023-11-07T05:31:56Z",
  "statisticsCounts": [
    {
      "type": "<string>",
      "value": 123
    }
  ],
  "statisticsDates": [
    {
      "type": "<string>",
      "value": "2023-11-07T05:31:56Z"
    }
  ]
}

Path Parameters

siteId
integer<int32>
required

Response

200 - application/json

OK

id
integer<int32>
clientID
integer<int32>
name
string | null
clientName
string | null
address1
string | null
address2
string | null
address3
string | null
suburb
string | null
state
string | null
postcode
string | null
country
string | null
countryName
string | null
createdById
integer<int32>
createdByName
string | null
updatedById
integer<int32>
updatedByName
string | null
statusID
integer<int32>
status
string | null
contacts
integer<int32>
createdDate
string<date-time>
updatedDate
string<date-time>
phone
string | null
primaryContact
integer<int32>
primaryContactName
string | null
primaryContactFirstName
string | null
primaryContactLastName
string | null
primaryContactEmail
string | null
primaryContactOptOut
string | null
phoneStandardised
string | null
description
string | null
tags
boolean
customField1
string | null
customField2
string | null
customField3
string | null
customField4
string | null
customField5
string | null
customField6
string | null
customField7
string | null
customField8
string | null
customField9
string | null
customField10
string | null
customField11
number<double>
customField12
number<double>
customField13
number<double>
customField14
number<double>
customField15
number<double>
customField16
string<date-time>
customField17
string<date-time>
customField18
string<date-time>
customField19
string<date-time>
customField20
string<date-time>
customField21
string | null
customField22
string | null
customField23
string | null
customField24
string | null
customField25
string | null
customField26
string | null
customField27
string | null
customField28
string | null
customField29
string | null
customField30
string | null
customField31
number<double>
customField32
number<double>
customField33
number<double>
customField34
number<double>
customField35
number<double>
customField36
string<date-time>
customField37
string<date-time>
customField38
string<date-time>
customField39
string<date-time>
customField40
string<date-time>
customField41
string | null
customField42
string | null
customField43
string | null
customField44
string | null
customField45
string | null
customField46
string | null
customField47
string | null
customField48
string | null
customField49
string | null
customField50
string | null
customField51
number<double>
customField52
number<double>
customField53
number<double>
customField54
number<double>
customField55
number<double>
customField56
string<date-time>
customField57
string<date-time>
customField58
string<date-time>
customField59
string<date-time>
customField60
string<date-time>
statisticsCounts
object[] | null
statisticsDates
object[] | null