Skip to main content
GET
/
v1
/
site
/
{id}
Get site (address) details
curl --request GET \
  --url https://connect.provisionapp.io/v1/site/{id} \
  --header 'x-api-key: <api-key>'
{
  "id": "<string>",
  "address1": "<string>",
  "address2": "<string>",
  "city": "<string>",
  "state": "<string>",
  "zip": "<string>",
  "tosAccepted": "<string>",
  "clientSegment": "<string>",
  "cppExpDate": "2023-11-07T05:31:56Z",
  "businessName": "<string>",
  "brandId": "<string>",
  "primaryClientId": "<string>",
  "primaryProjectId": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "sla": 123,
  "isMonitored": true,
  "accountManager": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "membershipRegistered": true,
  "clients": [
    {
      "id": "<string>",
      "name": "<string>",
      "firstName": "<string>",
      "lastName": "<string>",
      "partnerName": "<string>",
      "marketingOptOut": true,
      "emails": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "value": "jsmith@example.com",
          "label": "<string>",
          "isPrimary": true
        }
      ],
      "phoneNumbers": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "value": "<string>",
          "ext": 123,
          "label": "<string>",
          "isPrimary": true
        }
      ],
      "isPrimary": true
    }
  ],
  "projects": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "isPrimary": true,
      "stage": "<string>",
      "estimatedDay1": "2023-12-25",
      "day1StartDate": "2023-12-25",
      "warrantyExpiration": "2023-12-25",
      "signingDate": "2023-12-25"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Send the API key in the x-api-key header.

Path Parameters

id
string
required
Pattern: ^ovaid-.*$
Example:

"ovaid-22222222-2222-4222-8222-222222222222"

Query Parameters

include
string

Comma-separated relations to expand

Example:

"clients,projects"

Response

Site details

id
string
required
Pattern: ^ovaid-.*$
address1
string | null
required
address2
string | null
required
city
string | null
required
state
string | null
required
zip
string | null
required
tosAccepted
string
serviceLevel
enum<string>
Available options:
Inactive,
Non-Member,
Warranty Essentials,
CPP Essentials Plus,
Essentials Plus,
CPP Priority,
Priority,
CPP Proactive,
Proactive,
CPP Signature,
Signature,
Secure,
OV - Internal,
Legacy
clientSegment
string
cppExpDate
string<date-time>
businessName
string
brandId
string
primaryClientId
string
primaryProjectId
string
createdAt
string<date-time>
updatedAt
string<date-time>
sla
number
isMonitored
boolean
accountManager
object
membershipRegistered
boolean
clients
object[]
projects
object[]