Get site details

GET

site

{id}

Get site details

curl --request GET \
  --url https://connect.provisionapp.io/v1/site/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://connect.provisionapp.io/v1/site/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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"
    }
  ],
  "customProperties": {
    "warranty_count": 5,
    "region": "east",
    "onsite_required": true
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

Authorizations

x-api-key

string

header

required

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

Path Parameters

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

string

required

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

Show child attributes

membershipRegistered

boolean

clients

object[]

Show child attributes

projects

object[]

Show child attributes

customProperties

object

Custom property values, keyed by property id. Ids and value types come from the properties defined for your partner, so this object cannot be described field by field here — call the custom-property list endpoint to resolve an id to its name and type. A property never given a value takes the default configured for it, and is left out rather than returned as null when there is no default either. A value stored before its property was changed — an option renamed or removed, the type switched — is returned as stored, so it may not match the type the property has today; an absent key is the only reliable sign that nothing is set.

Show child attributes

Example:

{
  "warranty_count": 5,
  "region": "east",
  "onsite_required": true
}

Get site details

curl --request GET \
  --url https://connect.provisionapp.io/v1/site/{id} \
  --header 'x-api-key: <api-key>'

const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};

fetch('https://connect.provisionapp.io/v1/site/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "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"
    }
  ],
  "customProperties": {
    "warranty_count": 5,
    "region": "east",
    "onsite_required": true
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

{
  "error": {
    "code": "NOT_FOUND",
    "message": "<string>"
  }
}

system

site

conversation

client

user

Authorizations

Path Parameters

Query Parameters

Response