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": "..."
    }
  }
}

Definition

GET https://api.gosquared.com/people/v1/propertyTypes
Open Query Builder
Close

Authentication

Parameters * required

    Post Data * required

    Example Request

    require 'gosquared'
    
    gs = Gosquared::RubyLibrary.new('demo','GSN-106863-S')
    
    gs.people.propertyTypes
    
    gs.people.fetch
    

    Live Responseundefined undefined

    Your API Key is not authorised for this endpoint

    Retrieve all custom property types

    GETpeople/propertyTypes/custom

    The same as above but only returning custom properties.

    Definition

    GET https://api.gosquared.com/people/v1/propertyTypes/custom
    Open Query Builder
    Close

    Authentication

    Parameters * required

      Post Data * required

      Example Request

      require 'gosquared'
      
      gs = Gosquared::RubyLibrary.new('demo','GSN-106863-S')
      
      gs.people.propertyTypes.custom
      
      gs.people.fetch
      

      Live Responseundefined undefined

      Your API Key is not authorised for this endpoint

      Retrieve a property

      GETpeople/propertyTypes/{propertyID}

      Retrieves a single property by name

      Path Parameters

      propertyID

      StringRequired

      The ID of the property

      Definition

      GET https://api.gosquared.com/people/v1/propertyTypes/{propertyID}
      Open Query Builder
      Close

      Authentication

      Parameters * required

      Post Data * required

      Example Request

      require 'gosquared'
      
      gs = Gosquared::RubyLibrary.new('demo','GSN-106863-S')
      
      gs.people.propertyTypes
      
      gs.people.fetch
      

      Live Responseundefined undefined

      Your API Key is not authorised for this endpoint

      Please fill in the required fields in the Query Builder