Property Types

Retrieve all property types

GETpeople/propertyTypes

Retrieves a list of all types of properties that exist in People CRM. The property names use dot notation where a . represents a property so last.location.coordinates represent the object below in a returned Person object.

{
  "...": "...",
  "last": {
    "location": {
      "coordinates": "..."
    }
  }
}
Run in PostmanPostman is a useful developer tool for experimenting with and managing APIs that you work with

Definition

GET https://api.gosquared.com/people/v1/propertyTypes

Example Request

curl "https://api.gosquared.com/people/v1/propertyTypes?api_key=demo&site_token=GSN-106863-S" 

Live Responseundefined undefined

Your API Key is not authorised for this endpoint

Please fill in the required fields in the Query Builder

Retrieve all custom property types

GETpeople/propertyTypes/custom

The same as above but only returning custom properties.

Run in PostmanPostman is a useful developer tool for experimenting with and managing APIs that you work with

Definition

GET https://api.gosquared.com/people/v1/propertyTypes/custom

Example Request

curl "https://api.gosquared.com/people/v1/propertyTypes/custom?api_key=demo&site_token=GSN-106863-S" 

Live Responseundefined undefined

Your API Key is not authorised for this endpoint

Please fill in the required fields in the Query Builder

Retrieve a property

GETpeople/propertyTypes/{propertyID}

Retrieves a single property by name

Path Parameters

propertyID

StringRequired

The ID of the property

Run in PostmanPostman is a useful developer tool for experimenting with and managing APIs that you work with

Definition

GET https://api.gosquared.com/people/v1/propertyTypes/{propertyID}

Example Request

curl "https://api.gosquared.com/people/v1/propertyTypes/{propertyID}?api_key=demo&site_token=GSN-106863-S" 

Live Responseundefined undefined

Your API Key is not authorised for this endpoint

Please fill in the required fields in the Query Builder