CASAONE API1 v1.0.0

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

Base URLs:

https://api.test.casaone.ch/{company}/
- company - the slug of the tennant/company the request is pointing towards Default: dev

Authentication

HTTP Authentication, scheme: bearer

AddressWithAccessKey

getAddressWithContactAccessKey

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.test.casaone.ch/{company}/address-with-accesskey/:contact_accesskey/:address_with_accesskey_id',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.test.casaone.ch/{company}/address-with-accesskey/:contact_accesskey/:address_with_accesskey_id',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.test.casaone.ch/{company}/address-with-accesskey/:contact_accesskey/:address_with_accesskey_id', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.test.casaone.ch/{company}/address-with-accesskey/:contact_accesskey/:address_with_accesskey_id HTTP/1.1
Host: api.test.casaone.ch
Accept: application/json

GET /address-with-accesskey/:contact_accesskey/:address_with_accesskey_id

gives ability to externally access Address information

Parameters

Name	In	Type	Required	Description
contact_accesskey	query	undefined	true	hash that identifies Contact entity
address_with_accesskey_id	query	undefined	true	id that identifies Address entity

Example responses

200 Response

[
  {
    "id": 0,
    "unknownPlaceMunicipality": true,
    "unknownPlaceLocality": true,
    "country": "string",
    "postalCode": "string",
    "locality": "string",
    "casageoSlug": "string",
    "region": "string",
    "casageoRegionSlug": "string",
    "county": "string",
    "casageoCountySlug": "string",
    "municipality": "string",
    "casageoMunicipalitySlug": "string",
    "district": "string",
    "casageoDistrictSlug": "string",
    "district2": "string",
    "casageoDistrict2Slug": "string",
    "postalCodeMatchStatus": "string",
    "postOfficeBoxNumber": "string",
    "street": "string",
    "streetNumber": "string",
    "streetAddition": "string",
    "subunit": "string",
    "lat": "string",
    "lng": "string",
    "elevation": 0,
    "providedCoordinates": true,
    "failedCoordinateLookup": true,
    "hideExactAddress": true,
    "iaziOrtId": 0,
    "iaziMunicipalityId": 0,
    "hideInfrastructure": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	successful operation	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Address]	false	none	none
» id	integer	false	none	none
» unknownPlaceMunicipality	boolean	false	none	none
» unknownPlaceLocality	boolean	false	none	none
» country	Address/properties/country	false	none	none
» postalCode	Address/properties/postalCode	false	none	none
» locality	Address/properties/locality	false	none	none
» casageoSlug	string	false	none	none
» region	Address/properties/region	false	none	describes the canton in 2 characters
» casageoRegionSlug	string	false	none	none
» county	string	false	none	none
» casageoCountySlug	string	false	none	none
» municipality	string	false	none	none
» casageoMunicipalitySlug	string	false	none	none
» district	string	false	none	none
» casageoDistrictSlug	string	false	none	none
» district2	string	false	none	none
» casageoDistrict2Slug	string	false	none	none
» postalCodeMatchStatus	string	false	none	none
» postOfficeBoxNumber	Address/properties/postOfficeBoxNumber	false	none	none
» street	Address/properties/street	false	none	none
» streetNumber	Address/properties/streetNumber	false	none	none
» streetAddition	Address/properties/streetAddition	false	none	none
» subunit	string	false	none	none
» lat	Address/properties/lat	false	none	none
» lng	Address/properties/lng	false	none	none
» elevation	Address/properties/elevation	false	none	none
» providedCoordinates	boolean	false	none	none
» failedCoordinateLookup	boolean	false	none	none
» hideExactAddress	boolean	false	none	none
» iaziOrtId	integer	false	none	none
» iaziMunicipalityId	integer	false	none	none
» hideInfrastructure	boolean	false	none	none

editAddressWithContactAccessKey

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.test.casaone.ch/{company}/address-with-accesskey/:contact_accesskey/:address_with_accesskey_id',
{
  method: 'PATCH',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.test.casaone.ch/{company}/address-with-accesskey/:contact_accesskey/:address_with_accesskey_id',
{
  method: 'PATCH',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.test.casaone.ch/{company}/address-with-accesskey/:contact_accesskey/:address_with_accesskey_id', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH https://api.test.casaone.ch/{company}/address-with-accesskey/:contact_accesskey/:address_with_accesskey_id HTTP/1.1
Host: api.test.casaone.ch
Accept: application/json

PATCH /address-with-accesskey/:contact_accesskey/:address_with_accesskey_id

gives ability to externally edit Address information

Parameters

Name	In	Type	Required	Description
contact_accesskey	path	string	true	hash that identifies Contact entity
address_with_accesskey_id	path	integer	true	id that identifies Address entity
street	query	Address/properties/street	false	none
country	query	Address/properties/country	false	none
postalCode	query	Address/properties/postalCode	false	none
locality	query	Address/properties/locality	false	none
region	query	Address/properties/region	false	none
streetNumber	query	Address/properties/streetNumber	false	none
streetAddition	query	Address/properties/streetAddition	false	none
lat	query	Address/properties/lat	false	none
lng	query	Address/properties/lng	false	none
elevation	query	Address/properties/elevation	false	none
postOfficeBoxNumber	query	Address/properties/postOfficeBoxNumber	false	none

Example responses

200 Response

[
  {
    "id": 0,
    "unknownPlaceMunicipality": true,
    "unknownPlaceLocality": true,
    "country": "string",
    "postalCode": "string",
    "locality": "string",
    "casageoSlug": "string",
    "region": "string",
    "casageoRegionSlug": "string",
    "county": "string",
    "casageoCountySlug": "string",
    "municipality": "string",
    "casageoMunicipalitySlug": "string",
    "district": "string",
    "casageoDistrictSlug": "string",
    "district2": "string",
    "casageoDistrict2Slug": "string",
    "postalCodeMatchStatus": "string",
    "postOfficeBoxNumber": "string",
    "street": "string",
    "streetNumber": "string",
    "streetAddition": "string",
    "subunit": "string",
    "lat": "string",
    "lng": "string",
    "elevation": 0,
    "providedCoordinates": true,
    "failedCoordinateLookup": true,
    "hideExactAddress": true,
    "iaziOrtId": 0,
    "iaziMunicipalityId": 0,
    "hideInfrastructure": true
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	successful operation	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Address]	false	none	none
» id	integer	false	none	none
» unknownPlaceMunicipality	boolean	false	none	none
» unknownPlaceLocality	boolean	false	none	none
» country	Address/properties/country	false	none	none
» postalCode	Address/properties/postalCode	false	none	none
» locality	Address/properties/locality	false	none	none
» casageoSlug	string	false	none	none
» region	Address/properties/region	false	none	describes the canton in 2 characters
» casageoRegionSlug	string	false	none	none
» county	string	false	none	none
» casageoCountySlug	string	false	none	none
» municipality	string	false	none	none
» casageoMunicipalitySlug	string	false	none	none
» district	string	false	none	none
» casageoDistrictSlug	string	false	none	none
» district2	string	false	none	none
» casageoDistrict2Slug	string	false	none	none
» postalCodeMatchStatus	string	false	none	none
» postOfficeBoxNumber	Address/properties/postOfficeBoxNumber	false	none	none
» street	Address/properties/street	false	none	none
» streetNumber	Address/properties/streetNumber	false	none	none
» streetAddition	Address/properties/streetAddition	false	none	none
» subunit	string	false	none	none
» lat	Address/properties/lat	false	none	none
» lng	Address/properties/lng	false	none	none
» elevation	Address/properties/elevation	false	none	none
» providedCoordinates	boolean	false	none	none
» failedCoordinateLookup	boolean	false	none	none
» hideExactAddress	boolean	false	none	none
» iaziOrtId	integer	false	none	none
» iaziMunicipalityId	integer	false	none	none
» hideInfrastructure	boolean	false	none	none

createAddressWithContactAccessKey

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.test.casaone.ch/{company}/address-with-accesskey/:contact_accesskey',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.test.casaone.ch/{company}/address-with-accesskey/:contact_accesskey',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.test.casaone.ch/{company}/address-with-accesskey/:contact_accesskey', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.test.casaone.ch/{company}/address-with-accesskey/:contact_accesskey HTTP/1.1
Host: api.test.casaone.ch
Accept: application/json

POST /address-with-accesskey/:contact_accesskey

gives ability to externally create Address information

Parameters

Name	In	Type	Required	Description
contact_accesskey	path	string	true	hash that identifies Contact entity
street	query	Address/properties/street	false	none
country	query	Address/properties/country	false	none
postalCode	query	Address/properties/postalCode	false	none
locality	query	Address/properties/locality	false	none
region	query	Address/properties/region	false	none
streetNumber	query	Address/properties/streetNumber	false	none
streetAddition	query	Address/properties/streetAddition	false	none
lat	query	Address/properties/lat	false	none
lng	query	Address/properties/lng	false	none
elevation	query	Address/properties/elevation	false	none
postOfficeBoxNumber	query	Address/properties/postOfficeBoxNumber	false	none

Example responses

201 Response

[
  {
    "id": 0,
    "unknownPlaceMunicipality": true,
    "unknownPlaceLocality": true,
    "country": "string",
    "postalCode": "string",
    "locality": "string",
    "casageoSlug": "string",
    "region": "string",
    "casageoRegionSlug": "string",
    "county": "string",
    "casageoCountySlug": "string",
    "municipality": "string",
    "casageoMunicipalitySlug": "string",
    "district": "string",
    "casageoDistrictSlug": "string",
    "district2": "string",
    "casageoDistrict2Slug": "string",
    "postalCodeMatchStatus": "string",
    "postOfficeBoxNumber": "string",
    "street": "string",
    "streetNumber": "string",
    "streetAddition": "string",
    "subunit": "string",
    "lat": "string",
    "lng": "string",
    "elevation": 0,
    "providedCoordinates": true,
    "failedCoordinateLookup": true,
    "hideExactAddress": true,
    "iaziOrtId": 0,
    "iaziMunicipalityId": 0,
    "hideInfrastructure": true
  }
]

Responses

Status	Meaning	Description	Schema
201	Created	successful operation	Inline

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
anonymous	[Address]	false	none	none
» id	integer	false	none	none
» unknownPlaceMunicipality	boolean	false	none	none
» unknownPlaceLocality	boolean	false	none	none
» country	Address/properties/country	false	none	none
» postalCode	Address/properties/postalCode	false	none	none
» locality	Address/properties/locality	false	none	none
» casageoSlug	string	false	none	none
» region	Address/properties/region	false	none	describes the canton in 2 characters
» casageoRegionSlug	string	false	none	none
» county	string	false	none	none
» casageoCountySlug	string	false	none	none
» municipality	string	false	none	none
» casageoMunicipalitySlug	string	false	none	none
» district	string	false	none	none
» casageoDistrictSlug	string	false	none	none
» district2	string	false	none	none
» casageoDistrict2Slug	string	false	none	none
» postalCodeMatchStatus	string	false	none	none
» postOfficeBoxNumber	Address/properties/postOfficeBoxNumber	false	none	none
» street	Address/properties/street	false	none	none
» streetNumber	Address/properties/streetNumber	false	none	none
» streetAddition	Address/properties/streetAddition	false	none	none
» subunit	string	false	none	none
» lat	Address/properties/lat	false	none	none
» lng	Address/properties/lng	false	none	none
» elevation	Address/properties/elevation	false	none	none
» providedCoordinates	boolean	false	none	none
» failedCoordinateLookup	boolean	false	none	none
» hideExactAddress	boolean	false	none	none
» iaziOrtId	integer	false	none	none
» iaziMunicipalityId	integer	false	none	none
» hideInfrastructure	boolean	false	none	none

Contact

getContactResource

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.test.casaone.ch/{company}/contact/:contact_id',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.test.casaone.ch/{company}/contact/:contact_id',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('GET','https://api.test.casaone.ch/{company}/contact/:contact_id', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

GET https://api.test.casaone.ch/{company}/contact/:contact_id HTTP/1.1
Host: api.test.casaone.ch
Accept: application/json

GET /contact/:contact_id

get Contact Entity

Parameters

Name	In	Type	Required	Description
contact_id	path	string	true	Id that identifies Contact entity

Example responses

200 Response

[
  {
    "id": "string",
    "accessKey": "string",
    "importId": "string",
    "status": "string",
    "contactType": "string",
    "displayName": "string",
    "addition": "string",
    "legalForm": "string",
    "entityType": "string",
    "honorific": "string",
    "firstName": "string",
    "lastName": "string",
    "gender": 0,
    "lang": "string",
    "email": "string",
    "email2": "string",
    "phone": "string",
    "phoneDirect": "string",
    "mobile": "string",
    "fax": "string",
    "dob": "2024-07-17",
    "pob": "string",
    "poco": "string",
    "slogan": "string",
    "twitter": "string",
    "linkedin": "string",
    "facebook": "string",
    "pinterest": "string",
    "instagram": "string",
    "websiteUrl": "string",
    "websiteLabel": "string",
    "websiteTitle": "string",
    "function": "string",
    "profession": "string",
    "notes": "string",
    "salutationTemplate": "string",
    "civilStatus": "string",
    "uid": "string",
    "nationality": "string",
    "permit": "string",
    "internalNotes": "string",
    "visualReferenceId": "string",
    "importState": null,
    "shippingAddress": "string"
  }
]

Responses

Status	Meaning	Description	Schema
200	OK	successful operation	Inline

Response Schema

Status Code 200

Name	Type	Required	Restrictions	Description
anonymous	[Contact]	false	none	none
» id	string	false	none	none
» accessKey	string	false	none	none
» importId	string	false	none	none
» status	string	false	none	none
» contactType	string	false	none	none
» displayName	string	false	none	none
» addition	string	false	none	none
» legalForm	string	false	none	none
» entityType	string	false	none	none
» honorific	string	false	none	none
» firstName	string	false	none	none
» lastName	string	false	none	none
» gender	integer	false	none	none
» lang	string	false	none	none
» email	string	false	none	none
» email2	string	false	none	none
» phone	string	false	none	none
» phoneDirect	string	false	none	none
» mobile	string	false	none	none
» fax	string	false	none	none
» dob	string(date)	false	none	none
» pob	string	false	none	none
» poco	string	false	none	none
» slogan	string	false	none	none
» twitter	string	false	none	none
» linkedin	string	false	none	none
» facebook	string	false	none	none
» pinterest	string	false	none	none
» instagram	string	false	none	none
» websiteUrl	string	false	none	none
» websiteLabel	string	false	none	none
» websiteTitle	string	false	none	none
» function	string	false	none	none
» profession	string	false	none	none
» notes	string	false	none	none
» salutationTemplate	string	false	none	none
» civilStatus	string	false	none	none
» uid	string	false	none	none
» nationality	string	false	none	none
» permit	string	false	none	none
» internalNotes	string	false	none	none
» visualReferenceId	string	false	none	none
» importState	any	false	none	none
» shippingAddress	string	false	none	none

editContactResource

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.test.casaone.ch/{company}/contact/:contact_id',
{
  method: 'PATCH',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.test.casaone.ch/{company}/contact/:contact_id',
{
  method: 'PATCH',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('PATCH','https://api.test.casaone.ch/{company}/contact/:contact_id', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

PATCH https://api.test.casaone.ch/{company}/contact/:contact_id HTTP/1.1
Host: api.test.casaone.ch
Accept: application/json

PATCH /contact/:contact_id

edit Contact Entity

Parameters

Name	In	Type	Required	Description
contact_id	path	string	true	Id that identifies Contact entity
importId	query	string	false	none
status	query	string	false	none
contactType	query	string	false	none
displayName	query	string	false	none
legalForm	query	string	false	none
entityType	query	string	false	none
firstName	query	string	false	none
lastName	query	string	false	none
gender	query	integer	false	none
lang	query	string	false	none
email	query	string	false	none
phone	query	string	false	none
mobile	query	string	false	none
fax	query	string	false	none
dob	query	date	false	none
slogan	query	string	false	none
twitter	query	string	false	none
linkedin	query	string	false	none
facebook	query	string	false	none
pinterest	query	string	false	none
instagram	query	string	false	none
websiteUrl	query	string	false	none
websiteLabel	query	string	false	none
websiteTitle	query	string	false	none
function	query	string	false	none
created	query	string	false	none
updated	query	string	false	none
deleted	query	string	false	none
createdFromIp	query	string	false	none
updatedFromIp	query	string	false	none
id	query	string	false	none
address	query	string	false	none
source	query	string	false	Defines the source where the data came from. aka a 'crm' or 'casaauth' or 'google' or 'salesforce' etc.
sourceId	query	string	false	Defines the identifier of the source for future matching. This will also block editing and deletion because the contact data is actually retrieved from an external source.
notes	query	string	false	html based notes
employer	query	string	false	none
salutationTemplate	query	string	false	none
civilStatus	query	string	false	none
uid	query	string	false	none
nationality	query	string	false	none
permit	query	string	false	none
phoneDirect	query	string	false	none
poco	query	string	false	none
pob	query	string	false	none
honorific	query	string	false	none
profession	query	string	false	none
tags	query	string	false	none
addition	query	string	false	none
email2	query	string	false	none
avatar	query	string	false	none
logo	query	string	false	none
visualReferenceId	query	string	false	none
salesPerson	query	string	false	none
internalNotes	query	string	false	none
urls	query	string	false	none
shippingAddress	query	string	false	6 Line Textfield for postal address in Switzerland.

Example responses

201 Response

[
  {
    "id": "string",
    "accessKey": "string",
    "importId": "string",
    "status": "string",
    "contactType": "string",
    "displayName": "string",
    "addition": "string",
    "legalForm": "string",
    "entityType": "string",
    "honorific": "string",
    "firstName": "string",
    "lastName": "string",
    "gender": 0,
    "lang": "string",
    "email": "string",
    "email2": "string",
    "phone": "string",
    "phoneDirect": "string",
    "mobile": "string",
    "fax": "string",
    "dob": "2024-07-17",
    "pob": "string",
    "poco": "string",
    "slogan": "string",
    "twitter": "string",
    "linkedin": "string",
    "facebook": "string",
    "pinterest": "string",
    "instagram": "string",
    "websiteUrl": "string",
    "websiteLabel": "string",
    "websiteTitle": "string",
    "function": "string",
    "profession": "string",
    "notes": "string",
    "salutationTemplate": "string",
    "civilStatus": "string",
    "uid": "string",
    "nationality": "string",
    "permit": "string",
    "internalNotes": "string",
    "visualReferenceId": "string",
    "importState": null,
    "shippingAddress": "string"
  }
]

Responses

Status	Meaning	Description	Schema
201	Created	successful operation	Inline
422	Unprocessable Entity	Common validation error returned by laminas	ValidationError

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
anonymous	[Contact]	false	none	none
» id	string	false	none	none
» accessKey	string	false	none	none
» importId	string	false	none	none
» status	string	false	none	none
» contactType	string	false	none	none
» displayName	string	false	none	none
» addition	string	false	none	none
» legalForm	string	false	none	none
» entityType	string	false	none	none
» honorific	string	false	none	none
» firstName	string	false	none	none
» lastName	string	false	none	none
» gender	integer	false	none	none
» lang	string	false	none	none
» email	string	false	none	none
» email2	string	false	none	none
» phone	string	false	none	none
» phoneDirect	string	false	none	none
» mobile	string	false	none	none
» fax	string	false	none	none
» dob	string(date)	false	none	none
» pob	string	false	none	none
» poco	string	false	none	none
» slogan	string	false	none	none
» twitter	string	false	none	none
» linkedin	string	false	none	none
» facebook	string	false	none	none
» pinterest	string	false	none	none
» instagram	string	false	none	none
» websiteUrl	string	false	none	none
» websiteLabel	string	false	none	none
» websiteTitle	string	false	none	none
» function	string	false	none	none
» profession	string	false	none	none
» notes	string	false	none	none
» salutationTemplate	string	false	none	none
» civilStatus	string	false	none	none
» uid	string	false	none	none
» nationality	string	false	none	none
» permit	string	false	none	none
» internalNotes	string	false	none	none
» visualReferenceId	string	false	none	none
» importState	any	false	none	none
» shippingAddress	string	false	none	none

createContactResource

Code samples


const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.test.casaone.ch/{company}/contact',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.test.casaone.ch/{company}/contact',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

<?php

require 'vendor/autoload.php';

$headers = array(
    'Accept' => 'application/json',
    'Authorization' => 'Bearer {access-token}',

    );

$client = new \GuzzleHttp\Client();

// Define array of request body.
$request_body = array();

try {
    $response = $client->request('POST','https://api.test.casaone.ch/{company}/contact', array(
        'headers' => $headers,
        'json' => $request_body,
       )
    );
    print_r($response->getBody()->getContents());
 }
 catch (\GuzzleHttp\Exception\BadResponseException $e) {
    // handle exception or api errors.
    print_r($e->getMessage());
 }

 // ...

POST https://api.test.casaone.ch/{company}/contact HTTP/1.1
Host: api.test.casaone.ch
Accept: application/json

POST /contact

create Contact Entity

Parameters

Name	In	Type	Required	Description
importId	query	string	false	none
status	query	string	false	none
contactType	query	string	false	none
displayName	query	string	false	none
legalForm	query	string	false	none
entityType	query	string	false	none
firstName	query	string	false	none
lastName	query	string	false	none
gender	query	integer	false	none
lang	query	string	false	none
email	query	string	false	none
phone	query	string	false	none
mobile	query	string	false	none
fax	query	string	false	none
dob	query	date	false	none
slogan	query	string	false	none
twitter	query	string	false	none
linkedin	query	string	false	none
facebook	query	string	false	none
pinterest	query	string	false	none
instagram	query	string	false	none
websiteUrl	query	string	false	none
websiteLabel	query	string	false	none
websiteTitle	query	string	false	none
function	query	string	false	none
created	query	string	false	none
updated	query	string	false	none
deleted	query	string	false	none
createdFromIp	query	string	false	none
updatedFromIp	query	string	false	none
id	query	string	false	none
address	query	string	false	none
source	query	string	false	Defines the source where the data came from. aka a 'crm' or 'casaauth' or 'google' or 'salesforce' etc.
sourceId	query	string	false	Defines the identifier of the source for future matching. This will also block editing and deletion because the contact data is actually retrieved from an external source.
notes	query	string	false	html based notes
employer	query	string	false	none
salutationTemplate	query	string	false	none
civilStatus	query	string	false	none
uid	query	string	false	none
nationality	query	string	false	none
permit	query	string	false	none
phoneDirect	query	string	false	none
poco	query	string	false	none
pob	query	string	false	none
honorific	query	string	false	none
profession	query	string	false	none
tags	query	string	false	none
addition	query	string	false	none
email2	query	string	false	none
avatar	query	string	false	none
logo	query	string	false	none
visualReferenceId	query	string	false	none
salesPerson	query	string	false	none
internalNotes	query	string	false	none
urls	query	string	false	none
shippingAddress	query	string	false	6 Line Textfield for postal address in Switzerland.

Example responses

201 Response

[
  {
    "id": "string",
    "accessKey": "string",
    "importId": "string",
    "status": "string",
    "contactType": "string",
    "displayName": "string",
    "addition": "string",
    "legalForm": "string",
    "entityType": "string",
    "honorific": "string",
    "firstName": "string",
    "lastName": "string",
    "gender": 0,
    "lang": "string",
    "email": "string",
    "email2": "string",
    "phone": "string",
    "phoneDirect": "string",
    "mobile": "string",
    "fax": "string",
    "dob": "2024-07-17",
    "pob": "string",
    "poco": "string",
    "slogan": "string",
    "twitter": "string",
    "linkedin": "string",
    "facebook": "string",
    "pinterest": "string",
    "instagram": "string",
    "websiteUrl": "string",
    "websiteLabel": "string",
    "websiteTitle": "string",
    "function": "string",
    "profession": "string",
    "notes": "string",
    "salutationTemplate": "string",
    "civilStatus": "string",
    "uid": "string",
    "nationality": "string",
    "permit": "string",
    "internalNotes": "string",
    "visualReferenceId": "string",
    "importState": null,
    "shippingAddress": "string"
  }
]

Responses

Status	Meaning	Description	Schema
201	Created	successful operation	Inline

Response Schema

Status Code 201

Name	Type	Required	Restrictions	Description
anonymous	[Contact]	false	none	none
» id	string	false	none	none
» accessKey	string	false	none	none
» importId	string	false	none	none
» status	string	false	none	none
» contactType	string	false	none	none
» displayName	string	false	none	none
» addition	string	false	none	none
» legalForm	string	false	none	none
» entityType	string	false	none	none
» honorific	string	false	none	none
» firstName	string	false	none	none
» lastName	string	false	none	none
» gender	integer	false	none	none
» lang	string	false	none	none
» email	string	false	none	none
» email2	string	false	none	none
» phone	string	false	none	none
» phoneDirect	string	false	none	none
» mobile	string	false	none	none
» fax	string	false	none	none
» dob	string(date)	false	none	none
» pob	string	false	none	none
» poco	string	false	none	none
» slogan	string	false	none	none
» twitter	string	false	none	none
» linkedin	string	false	none	none
» facebook	string	false	none	none
» pinterest	string	false	none	none
» instagram	string	false	none	none
» websiteUrl	string	false	none	none
» websiteLabel	string	false	none	none
» websiteTitle	string	false	none	none
» function	string	false	none	none
» profession	string	false	none	none
» notes	string	false	none	none
» salutationTemplate	string	false	none	none
» civilStatus	string	false	none	none
» uid	string	false	none	none
» nationality	string	false	none	none
» permit	string	false	none	none
» internalNotes	string	false	none	none
» visualReferenceId	string	false	none	none
» importState	any	false	none	none
» shippingAddress	string	false	none	none

Schemas

ApiProblem

{
  "type": "string",
  "detail": null,
  "status": 0
}

ApiProblem

Properties

Name	Type	Required	Restrictions	Description
type	string	true	none	URL describing the problem type; defaults to HTTP status codes.
detail	any	false	none	Description of the specific problem.
status	integer	true	none	HTTP status for the error.

ValidationError

{
  "type": "string",
  "detail": null,
  "status": 0,
  "validation_messages": {}
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	ApiProblem	false	none	the custom ApiProblem can hide the detail key in production environment to avoid leaking internal system information

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» validation_messages	any	false	none	none

oneOf

Name	Type	Required	Restrictions	Description
»» anonymous	object¦null	false	none	contains validation message objects in object with string keys for status 422

xor

Name	Type	Required	Restrictions	Description
»» anonymous	[any]¦null	false	none	contains validation message objects in array for status 422

Address

{
  "id": 0,
  "unknownPlaceMunicipality": true,
  "unknownPlaceLocality": true,
  "country": "string",
  "postalCode": "string",
  "locality": "string",
  "casageoSlug": "string",
  "region": "string",
  "casageoRegionSlug": "string",
  "county": "string",
  "casageoCountySlug": "string",
  "municipality": "string",
  "casageoMunicipalitySlug": "string",
  "district": "string",
  "casageoDistrictSlug": "string",
  "district2": "string",
  "casageoDistrict2Slug": "string",
  "postalCodeMatchStatus": "string",
  "postOfficeBoxNumber": "string",
  "street": "string",
  "streetNumber": "string",
  "streetAddition": "string",
  "subunit": "string",
  "lat": "string",
  "lng": "string",
  "elevation": 0,
  "providedCoordinates": true,
  "failedCoordinateLookup": true,
  "hideExactAddress": true,
  "iaziOrtId": 0,
  "iaziMunicipalityId": 0,
  "hideInfrastructure": true
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
unknownPlaceMunicipality	boolean	false	none	none
unknownPlaceLocality	boolean	false	none	none
country	string	false	none	none
postalCode	string	false	none	none
locality	string	false	none	none
casageoSlug	string	false	none	none
region	string	false	none	describes the canton in 2 characters
casageoRegionSlug	string	false	none	none
county	string	false	none	none
casageoCountySlug	string	false	none	none
municipality	string	false	none	none
casageoMunicipalitySlug	string	false	none	none
district	string	false	none	none
casageoDistrictSlug	string	false	none	none
district2	string	false	none	none
casageoDistrict2Slug	string	false	none	none
postalCodeMatchStatus	string	false	none	none
postOfficeBoxNumber	string	false	none	none
street	string	false	none	none
streetNumber	string	false	none	none
streetAddition	string	false	none	none
subunit	string	false	none	none
lat	string	false	none	none
lng	string	false	none	none
elevation	integer	false	none	none
providedCoordinates	boolean	false	none	none
failedCoordinateLookup	boolean	false	none	none
hideExactAddress	boolean	false	none	none
iaziOrtId	integer	false	none	none
iaziMunicipalityId	integer	false	none	none
hideInfrastructure	boolean	false	none	none

CasaMessageSetting

{
  "id": 0,
  "user": {
    "username": "string",
    "role": "string",
    "firstCheckIn": "2023-10-12T07:10:17Z",
    "filterPresets": null,
    "completedTours": null,
    "sendInquiryNotificationEmails": true,
    "sendPushNotifications": true,
    "status": "string",
    "lastRoute": "string",
    "nylasAuthRequest": "2023-10-12T07:10:17Z"
  },
  "specialFolderNameOrId": "string",
  "messagesPrivateOnImport": true,
  "casaMessageSettingId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
user	User	false	none	none
specialFolderNameOrId	string¦null	false	none	none
messagesPrivateOnImport	boolean	false	none	none
casaMessageSettingId	string	false	none	none

Contact

{
  "id": "string",
  "accessKey": "string",
  "importId": "string",
  "status": "string",
  "contactType": "string",
  "displayName": "string",
  "addition": "string",
  "legalForm": "string",
  "entityType": "string",
  "honorific": "string",
  "firstName": "string",
  "lastName": "string",
  "gender": 0,
  "lang": "string",
  "email": "string",
  "email2": "string",
  "phone": "string",
  "phoneDirect": "string",
  "mobile": "string",
  "fax": "string",
  "dob": "2024-07-17",
  "pob": "string",
  "poco": "string",
  "slogan": "string",
  "twitter": "string",
  "linkedin": "string",
  "facebook": "string",
  "pinterest": "string",
  "instagram": "string",
  "websiteUrl": "string",
  "websiteLabel": "string",
  "websiteTitle": "string",
  "function": "string",
  "profession": "string",
  "notes": "string",
  "salutationTemplate": "string",
  "civilStatus": "string",
  "uid": "string",
  "nationality": "string",
  "permit": "string",
  "internalNotes": "string",
  "visualReferenceId": "string",
  "importState": null,
  "shippingAddress": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
accessKey	string	false	none	none
importId	string	false	none	none
status	string	false	none	none
contactType	string	false	none	none
displayName	string	false	none	none
addition	string	false	none	none
legalForm	string	false	none	none
entityType	string	false	none	none
honorific	string	false	none	none
firstName	string	false	none	none
lastName	string	false	none	none
gender	integer	false	none	none
lang	string	false	none	none
email	string	false	none	none
email2	string	false	none	none
phone	string	false	none	none
phoneDirect	string	false	none	none
mobile	string	false	none	none
fax	string	false	none	none
dob	string(date)	false	none	none
pob	string	false	none	none
poco	string	false	none	none
slogan	string	false	none	none
twitter	string	false	none	none
linkedin	string	false	none	none
facebook	string	false	none	none
pinterest	string	false	none	none
instagram	string	false	none	none
websiteUrl	string	false	none	none
websiteLabel	string	false	none	none
websiteTitle	string	false	none	none
function	string	false	none	none
profession	string	false	none	none
notes	string	false	none	none
salutationTemplate	string	false	none	none
civilStatus	string	false	none	none
uid	string	false	none	none
nationality	string	false	none	none
permit	string	false	none	none
internalNotes	string	false	none	none
visualReferenceId	string	false	none	none
importState	any	false	none	none
shippingAddress	string	false	none	none

ContactMedia

{
  "id": 0,
  "alt": "string",
  "title": "string",
  "caption": "string",
  "description": "string",
  "type": "string",
  "publication": "string",
  "flagged": "string",
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
alt	string	false	none	none
title	string	false	none	none
caption	string	false	none	none
description	string	false	none	none
type	string	false	none	none
publication	string	false	none	none
flagged	string	false	none	none
rank	integer	false	none	none

ContactMortgage

{
  "id": 0,
  "type": "string",
  "product": "string",
  "endDate": "2024-07-17",
  "amount": 0,
  "interestRate": 0,
  "note": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
type	string	false	none	none
product	string	false	none	none
endDate	string(date)	false	none	none
amount	integer	false	none	none
interestRate	number(float)	false	none	none
note	string	false	none	none

ContactRelation

{
  "id": 0,
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
type	string	false	none	none

ContactSearchprofile

{
  "id": 0,
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
rank	integer	false	none	none

ContactSearchprofileCategory

{
  "id": 0,
  "slug": "string",
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
slug	string	false	none	none
rank	integer	false	none	none

ContactSearchprofileFeature

{
  "id": 0,
  "slug": "string",
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
slug	string	false	none	none
rank	integer	false	none	none

ContactSearchprofileUtility

{
  "id": 0,
  "slug": "string",
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
slug	string	false	none	none
rank	integer	false	none	none

ContactTag

{
  "id": 0,
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none

EmailSetting

{
  "id": 0,
  "useSpecialFolder": true,
  "messagesPrivateOnImport": true,
  "companyEmailSetting": true
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
useSpecialFolder	boolean	false	none	none
messagesPrivateOnImport	boolean	false	none	none
companyEmailSetting	boolean	false	none	none

EmailSettingImapSmtp

{
  "id": 0,
  "useSpecialFolder": true,
  "messagesPrivateOnImport": true,
  "companyEmailSetting": true,
  "smtpName": "string",
  "smtpHost": "string",
  "smtpPort": 0,
  "smtpConnectionClass": "string",
  "smtpUsername": "string",
  "smtpPassword": "string",
  "smtpSslType": "string",
  "smtpSenderName": "string",
  "smtpSenderEmail": "string",
  "messageConsumerType": "string",
  "messageSenderType": "string",
  "imapHost": "string",
  "imapUser": "string",
  "imapPassword": "string",
  "imapPasswordUpdated": "2023-10-12T07:10:17Z",
  "imapPort": 0,
  "imapSslType": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	EmailSetting	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» smtpName	string	false	none	none
» smtpHost	string	false	none	none
» smtpPort	integer	false	none	none
» smtpConnectionClass	string	false	none	none
» smtpUsername	string	false	none	none
» smtpPassword	string	false	none	none
» smtpSslType	string	false	none	none
» smtpSenderName	string	false	none	none
» smtpSenderEmail	string	false	none	none
» messageConsumerType	string	false	none	none
» messageSenderType	string	false	none	none
» imapHost	string	false	none	none
» imapUser	string	false	none	none
» imapPassword	string	false	none	none
» imapPasswordUpdated	string(date-time)	false	none	none
» imapPort	integer	false	none	none
» imapSslType	string	false	none	none

EmailSettingNylas

{
  "id": 0,
  "useSpecialFolder": true,
  "messagesPrivateOnImport": true,
  "companyEmailSetting": true,
  "accessToken": "string",
  "accountId": "string",
  "emailAddress": "string",
  "provider": "string",
  "tokenType": "string"
}

Properties

allOf

Name	Type	Required	Restrictions	Description
anonymous	EmailSetting	false	none	none

and

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	none
» accessToken	string	false	none	none
» accountId	string	false	none	none
» emailAddress	string	false	none	none
» provider	string	false	none	none
» tokenType	string	false	none	none

Event

{
  "id": "string",
  "importId": "string",
  "customSource": "string",
  "threadUpdated": "2023-10-12T07:10:17Z",
  "status": "string",
  "doneReason": "string",
  "type": "string",
  "transcript": null,
  "start": "2023-10-12T07:10:17Z",
  "end": "2023-10-12T07:10:17Z",
  "reminderDate": "2023-10-12T07:10:17Z",
  "txt": "string",
  "html": "string",
  "gatewayPublisher": "string",
  "subject": "string",
  "lang": "string",
  "private": true,
  "offerAmount": 0,
  "requestedRelationType": "string",
  "nylasThreadId": "string",
  "nylasMessageId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
importId	string	false	none	none
customSource	string	false	none	none
threadUpdated	string(date-time)	false	none	none
status	string	false	none	none
doneReason	string	false	none	none
type	string	false	none	none
transcript	any	false	none	none
start	string(date-time)	false	none	none
end	string(date-time)	false	none	none
reminderDate	string(date-time)	false	none	none
txt	string	false	none	none
html	string	false	none	none
gatewayPublisher	string	false	none	none
subject	string	false	none	none
lang	string	false	none	none
private	boolean	false	none	none
offerAmount	integer	false	none	none
requestedRelationType	string	false	none	none
nylasThreadId	string	false	none	none
nylasMessageId	string	false	none	none

EventAttendee

{
  "id": 0,
  "rank": 0,
  "private": true
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
rank	integer	false	none	none
private	boolean	false	none	none

EventMedia

{
  "id": 0,
  "alt": "string",
  "title": "string",
  "caption": "string",
  "description": "string",
  "type": "string",
  "flagged": "string",
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
alt	string	false	none	none
title	string	false	none	none
caption	string	false	none	none
description	string	false	none	none
type	string	false	none	none
flagged	string	false	none	none
rank	integer	false	none	none

EventPhase

{
  "id": 0,
  "deleted": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
deleted	string(date-time)	false	none	none

EventTag

{
  "id": 0,
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none

EventType

{
  "id": "string",
  "baseType": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
baseType	string	false	none	none

EventTypeContent

{
  "id": 0,
  "lang": "string",
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
lang	string	false	none	none
name	string	false	none	none

EventUrl

{
  "id": 0,
  "url": "string",
  "title": "string",
  "label": "string",
  "type": "string",
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
url	string	false	none	none
title	string	false	none	none
label	string	false	none	none
type	string	false	none	none
rank	integer	false	none	none

GdprRequest

{
  "id": "string",
  "response": "string",
  "service": null,
  "type": null,
  "status": null,
  "jobId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
response	string	false	none	none
service	any	false	none	none
type	any	false	none	none
status	any	false	none	none
jobId	string	false	none	none

Job

{
  "id": "string",
  "jobGatewayId": "string",
  "importId": "string",
  "status": null,
  "employment": null,
  "position": null,
  "start": "2023-10-12T07:10:17Z",
  "end": "2023-10-12T07:10:17Z",
  "ageFrom": 0,
  "ageTo": 0,
  "vacancyFrom": 0,
  "vacancyTo": 0,
  "internalNotes": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
jobGatewayId	string	false	none	none
importId	string	false	none	none
status	any	false	none	none
employment	any	false	none	none
position	any	false	none	none
start	string(date-time)	false	none	none
end	string(date-time)	false	none	none
ageFrom	integer	false	none	none
ageTo	integer	false	none	none
vacancyFrom	integer	false	none	none
vacancyTo	integer	false	none	none
internalNotes	string	false	none	none

JobCategory

{
  "id": 0,
  "slug": null,
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
slug	JobCategory	false	none	none
rank	integer	false	none	none

JobContent

{
  "id": 0,
  "lang": "string",
  "excerpt": "string",
  "name": "string",
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
lang	string	false	none	none
excerpt	string	false	none	none
name	string	false	none	none
rank	integer	false	none	none

JobContentDescription

{
  "id": 0,
  "text": "string",
  "html": "string",
  "title": "string",
  "type": "string",
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
text	string	false	none	none
html	string	false	none	none
title	string	false	none	none
type	string	false	none	none
rank	integer	false	none	none

JobContentUrl

{
  "id": 0,
  "url": "string",
  "label": "string",
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
url	string	false	none	none
label	string	false	none	none
rank	integer	false	none	none

JobEducation

{
  "id": 0,
  "slug": null,
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
slug	JobEducation	false	none	none
rank	integer	false	none	none

JobLanguageRequirement

{
  "id": 0,
  "lang": "string",
  "proficiency": "string",
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
lang	string	false	none	none
proficiency	string	false	none	none
rank	integer	false	none	none

JobPublisher

{
  "id": 0,
  "publisher": "string",
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
publisher	string	false	none	none
rank	integer	false	none	none

LogEntry

null

Properties

None

Media

{
  "id": "string",
  "importId": "string",
  "path": "string",
  "originalFilename": "string",
  "alt": "string",
  "size": 0,
  "width": 0,
  "height": 0,
  "crop1x1": "string",
  "orientation": 0,
  "mimeType": "string",
  "thumbsPrepared": true,
  "orientationChecked": true,
  "isProxy": true,
  "status": "string",
  "viewGroup": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
importId	string	false	none	none
path	string	false	none	none
originalFilename	string	false	none	none
alt	string	false	none	none
size	integer	false	none	none
width	integer	false	none	none
height	integer	false	none	none
crop1x1	string	false	none	none
orientation	integer	false	none	none
mimeType	string	false	none	none
thumbsPrepared	boolean	false	none	none
orientationChecked	boolean	false	none	none
isProxy	boolean	false	none	none
status	string	false	none	none
viewGroup	string	false	none	none

MediaTag

{
  "id": 0,
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none

Phase

{
  "id": "string",
  "color": "string",
  "pipeline": null,
  "status": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
color	string	false	none	none
pipeline	any	false	none	none
status	string	false	none	none

PhaseContent

{
  "id": 0,
  "lang": "string",
  "name": "string",
  "excerpt": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
lang	string	false	none	none
name	string	false	none	none
excerpt	string	false	none	none

PhaseEventTypeRule

{
  "id": 0,
  "baseType": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
baseType	string	false	none	none

Place

{
  "id": 0,
  "casageoId": "string",
  "casageoLvl": "string",
  "multipolygon": null,
  "totalTaxNoChurch": 0,
  "totalTaxProtestant": 0,
  "totalTaxCatholic": 0,
  "totalTaxLegalEntity": 0,
  "totalTaxChristianCatholic": 0,
  "websiteUrl": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
casageoId	string	false	none	none
casageoLvl	string	false	none	none
multipolygon	any	false	none	none
totalTaxNoChurch	number(float)	false	none	none
totalTaxProtestant	number(float)	false	none	none
totalTaxCatholic	number(float)	false	none	none
totalTaxLegalEntity	number(float)	false	none	none
totalTaxChristianCatholic	number(float)	false	none	none
websiteUrl	string	false	none	none

PlaceContent

{
  "id": 0,
  "rank": 0,
  "lang": "string",
  "name": "string",
  "text": "string",
  "html": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
rank	integer	false	none	none
lang	string	false	none	none
name	string	false	none	none
text	string	false	none	none
html	string	false	none	none

Property

{
  "id": "string",
  "level": 0,
  "importId": "string",
  "gwId": 0,
  "gwStatus": "string",
  "gwLastCheck": "2023-10-12T07:10:17Z",
  "gwModified": "2023-10-12T07:10:17Z",
  "egrid": "string",
  "egid": "string",
  "ewid": "string",
  "rank": 0,
  "ref": "string",
  "inquiryEmailsGoTo": "string",
  "zoneTypes": "string",
  "parcelNumbers": "string",
  "status": "string",
  "marketingMethod": "string",
  "propertyType": "string",
  "start": "2023-10-12T07:10:17Z",
  "priceCurrency": "string",
  "price": 0,
  "priceRangeFrom": 0,
  "priceRangeTo": 0,
  "rentPriceRangeFrom": 0,
  "rentPriceRangeTo": 0,
  "pricePropertySegment": "string",
  "rentPriceTimeSegment": "string",
  "rentPricePropertySegment": "string",
  "netPrice": 0,
  "grossPrice": 0,
  "visualReferenceId": "string",
  "floor": 0,
  "numberOfFloors": 0,
  "numberOfApartments": 0,
  "numberOfBuildings": 0,
  "numberOfCommercialUnits": 0,
  "numberOfBathrooms": 0,
  "numberOfGuestToilets": 0,
  "numberOfRooms": 0,
  "numberOfRoomsFrom": 0,
  "numberOfRoomsTo": 0,
  "areaSiaGf": 0,
  "areaSiaNf": 0,
  "areaSiaNfFrom": 0,
  "areaSiaNfTo": 0,
  "areaCellar": 0,
  "areaBalcony": 0,
  "areaLoggia": 0,
  "areaGarden": 0,
  "areaTerrace": 0,
  "volumeSiaGv": 0,
  "volumeUnknownGv": 0,
  "areaSiaGsf": 0,
  "areaSiaGgf": 0,
  "volumeGva": 0,
  "volumeSia116Gv": 0,
  "utilizationNumber": 0,
  "areaBwf": 0,
  "areaBwfFrom": 0,
  "areaBwfTo": 0,
  "areaNwf": 0,
  "yearBuilt": 0,
  "yearLastRenovated": 0,
  "ceilingHeight": 0,
  "hallHeight": 0,
  "propertyLandPrice": 0,
  "grossPremium": 0,
  "netPremium": 0,
  "rentalDeposit": 0,
  "rentalIncomeGross": 0,
  "rentalIncomeNet": 0,
  "heatGeneration": "string",
  "heatDistribution": "string",
  "propertyDevelopment": "string",
  "geakExterior": 0,
  "geakTotal": 0,
  "extraCostsTotal": 0,
  "buildingInsuranceValue": 0,
  "officialTaxValue": 0,
  "imputedRentValue": 0,
  "renewalFundInput": 0,
  "renewalFundValue": 0,
  "renewalFundDate": "2023-10-12T07:10:17Z",
  "constructedFactor": 0,
  "ownershipShare": "string",
  "sNumber": "string",
  "unitNumber": "string",
  "internalDesignation": "string",
  "iaziLastValuation": null,
  "iaziLastValuationOptions": null,
  "exclusive": true,
  "contractStart": "2023-10-12T07:10:17Z",
  "contractEnd": "2023-10-12T07:10:17Z",
  "internalNotes": "string",
  "rentalIncomeNetMaxPotential": 0,
  "occupancyPercentage": 0,
  "occupancyPercentageDate": "2024-07-17",
  "grossPremiumTarget": 0,
  "yearlyOperationAndMaintenanceCosts": 0,
  "salesMethod": null,
  "auctionStartPrice": 0,
  "auctionStartDate": "2023-10-12T07:10:17Z",
  "auctionEndDate": "2023-10-12T07:10:17Z",
  "auctionMinimalIncrease": 0,
  "biddingStartPrice": 0,
  "biddingStartDate": "2023-10-12T07:10:17Z",
  "biddingBindingStartDate": "2023-10-12T07:10:17Z",
  "biddingEndDate": "2023-10-12T07:10:17Z",
  "salesStartDate": "2023-10-12T07:10:17Z",
  "salesEndDate": "2023-10-12T07:10:17Z",
  "constructionStatus": "string",
  "importState": null
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
level	integer	false	none	none
importId	string	false	none	none
gwId	integer	false	none	none
gwStatus	string	false	none	none
gwLastCheck	string(date-time)	false	none	none
gwModified	string(date-time)	false	none	none
egrid	string	false	none	none
egid	string	false	none	none
ewid	string	false	none	none
rank	integer	false	none	none
ref	string	false	none	none
inquiryEmailsGoTo	string	false	none	none
zoneTypes	string	false	none	none
parcelNumbers	string	false	none	none
status	string	false	none	none
marketingMethod	string	false	none	none
propertyType	string	false	none	none
start	string(date-time)	false	none	none
priceCurrency	string	false	none	none
price	integer	false	none	none
priceRangeFrom	integer	false	none	none
priceRangeTo	integer	false	none	none
rentPriceRangeFrom	integer	false	none	none
rentPriceRangeTo	integer	false	none	none
pricePropertySegment	string	false	none	none
rentPriceTimeSegment	string	false	none	none
rentPricePropertySegment	string	false	none	none
netPrice	integer	false	none	none
grossPrice	integer	false	none	none
visualReferenceId	string	false	none	none
floor	integer	false	none	none
numberOfFloors	integer	false	none	none
numberOfApartments	integer	false	none	Used in SwissRets export as NumberOfResidentialUnits
numberOfBuildings	integer	false	none	none
numberOfCommercialUnits	integer	false	none	none
numberOfBathrooms	integer	false	none	none
numberOfGuestToilets	integer	false	none	none
numberOfRooms	number(float)	false	none	none
numberOfRoomsFrom	number(float)	false	none	none
numberOfRoomsTo	number(float)	false	none	none
areaSiaGf	integer	false	none	none
areaSiaNf	integer	false	none	none
areaSiaNfFrom	integer	false	none	none
areaSiaNfTo	integer	false	none	none
areaCellar	integer	false	none	none
areaBalcony	integer	false	none	none
areaLoggia	integer	false	none	none
areaGarden	integer	false	none	none
areaTerrace	integer	false	none	none
volumeSiaGv	integer	false	none	none
volumeUnknownGv	integer	false	none	none
areaSiaGsf	integer	false	none	none
areaSiaGgf	integer	false	none	none
volumeGva	integer	false	none	none
volumeSia116Gv	integer	false	none	none
utilizationNumber	number(float)	false	none	none
areaBwf	integer	false	none	none
areaBwfFrom	integer	false	none	none
areaBwfTo	integer	false	none	none
areaNwf	integer	false	none	none
yearBuilt	integer	false	none	none
yearLastRenovated	integer	false	none	none
ceilingHeight	number(float)	false	none	none
hallHeight	number(float)	false	none	none
propertyLandPrice	integer	false	none	none
grossPremium	number(float)	false	none	none
netPremium	number(float)	false	none	none
rentalDeposit	integer	false	none	none
rentalIncomeGross	integer	false	none	none
rentalIncomeNet	integer	false	none	none
heatGeneration	string	false	none	none
heatDistribution	string	false	none	none
propertyDevelopment	string	false	none	none
geakExterior	integer	false	none	none
geakTotal	integer	false	none	none
extraCostsTotal	integer	false	none	none
buildingInsuranceValue	integer	false	none	none
officialTaxValue	integer	false	none	none
imputedRentValue	integer	false	none	none
renewalFundInput	integer	false	none	none
renewalFundValue	integer	false	none	none
renewalFundDate	string(date-time)	false	none	none
constructedFactor	number(float)	false	none	none
ownershipShare	string	false	none	none
sNumber	string	false	none	none
unitNumber	string	false	none	none
internalDesignation	string	false	none	none
iaziLastValuation	any	false	none	none
iaziLastValuationOptions	any	false	none	none
exclusive	boolean	false	none	none
contractStart	string(date-time)	false	none	none
contractEnd	string(date-time)	false	none	none
internalNotes	string	false	none	none
rentalIncomeNetMaxPotential	integer	false	none	none
occupancyPercentage	number(float)	false	none	none
occupancyPercentageDate	string(date)	false	none	none
grossPremiumTarget	number(float)	false	none	none
yearlyOperationAndMaintenanceCosts	integer	false	none	none
salesMethod	any	false	none	none
auctionStartPrice	integer	false	none	none
auctionStartDate	string(date-time)	false	none	none
auctionEndDate	string(date-time)	false	none	none
auctionMinimalIncrease	integer	false	none	none
biddingStartPrice	integer	false	none	none
biddingStartDate	string(date-time)	false	none	none
biddingBindingStartDate	string(date-time)	false	none	none
biddingEndDate	string(date-time)	false	none	none
salesStartDate	string(date-time)	false	none	none
salesEndDate	string(date-time)	false	none	none
constructionStatus	string	false	none	none
importState	any	false	none	none

PropertyCategory

{
  "id": 0,
  "slug": "string",
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
slug	string	false	none	none
rank	integer	false	none	none

PropertyConfiguration

{
  "id": 0,
  "primaryColor": "string",
  "secondaryColor": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
primaryColor	string	false	none	none
secondaryColor	string	false	none	none

PropertyContact

{
  "id": 0,
  "relationType": "string",
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
relationType	string	false	none	none
rank	integer	false	none	none

PropertyContent

{
  "id": 0,
  "lang": "string",
  "status": "string",
  "excerpt": "string",
  "name": "string",
  "visitNotes": "string",
  "slug": "string",
  "rank": 0,
  "customFields": null,
  "childCols": null,
  "distances": null
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
lang	string	false	none	none
status	string	false	none	none
excerpt	string	false	none	none
name	string	false	none	none
visitNotes	string	false	none	none
slug	string	false	none	none
rank	integer	false	none	none
customFields	any	false	none	none
childCols	any	false	none	none
distances	any	false	none	none

PropertyContentDescription

{
  "id": 0,
  "text": "string",
  "html": "string",
  "title": "string",
  "rank": 0,
  "type": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
text	string	false	none	none
html	string	false	none	none
title	string	false	none	none
rank	integer	false	none	none
type	string	false	none	none

PropertyContentMedia

{
  "id": 0,
  "alt": "string",
  "title": "string",
  "caption": "string",
  "description": "string",
  "type": "string",
  "publication": "string",
  "flagged": "string",
  "rank": 0,
  "fillPage": true,
  "attachToDocumentation": true
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
alt	string	false	none	none
title	string	false	none	none
caption	string	false	none	none
description	string	false	none	none
type	string	false	none	none
publication	string	false	none	none
flagged	string	false	none	none
rank	integer	false	none	none
fillPage	boolean	false	none	none
attachToDocumentation	boolean	false	none	none

PropertyContentUrl

{
  "id": 0,
  "url": "string",
  "title": "string",
  "label": "string",
  "type": "string",
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
url	string	false	none	none
title	string	false	none	none
label	string	false	none	none
type	string	false	none	none
rank	integer	false	none	none

PropertyExtracost

{
  "id": 0,
  "type": "string",
  "title": "string",
  "cost": 0,
  "frequency": 0,
  "timeSegment": "string",
  "propertySegment": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
type	string	false	none	none
title	string	false	none	none
cost	integer	false	none	none
frequency	integer	false	none	none
timeSegment	string	false	none	none
propertySegment	string	false	none	none

PropertyFeature

{
  "id": 0,
  "slug": "string",
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
slug	string	false	none	none
rank	integer	false	none	none

PropertyIntegratedOffer

{
  "id": 0,
  "rank": 0,
  "type": "string",
  "cost": 0,
  "ownershipShare": "string",
  "count": 0,
  "frequency": 0,
  "timeSegment": "string",
  "propertySegment": "string",
  "inclusive": true,
  "marketingMethod": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
rank	integer	false	none	none
type	string	false	none	none
cost	integer	false	none	none
ownershipShare	string	false	none	none
count	integer	false	none	none
frequency	integer	false	none	none
timeSegment	string	false	none	none
propertySegment	string	false	none	none
inclusive	boolean	false	none	none
marketingMethod	string	false	none	none

PropertyPublisher

{
  "id": 0,
  "publisher": "string",
  "rank": 0,
  "options": null
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
publisher	string	false	none	none
rank	integer	false	none	none
options	any	false	none	none

PropertyPublisherChannel

{
  "id": 0,
  "rank": 0,
  "slug": "string",
  "start": "2023-10-12T07:10:17Z",
  "expiration": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
rank	integer	false	none	none
slug	string	false	none	none
start	string(date-time)	false	none	none
expiration	string(date-time)	false	none	none

PropertyPublisherMedia

{
  "id": 0,
  "rank": 0,
  "slug": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
rank	integer	false	none	none
slug	string	false	none	none

PropertyRentaldepositProvider

{
  "id": 0,
  "rank": 0,
  "calculation": 0,
  "depositProvider": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
rank	integer	false	none	none
calculation	integer	false	none	none
depositProvider	string	false	none	none

PropertyReport

{
  "id": 0,
  "rank": 0,
  "start": "2023-10-12T07:10:17Z",
  "recencyDays": 0,
  "showContactList": true,
  "showDenialReasons": true,
  "showClientOrigins": true,
  "showInquiries": true,
  "showEvents": true,
  "showTimeSpent": true,
  "showPublication": true,
  "showEventContent": true,
  "showPhases": true,
  "showOffers": true,
  "status": "string",
  "emailFrequency": "string",
  "emailAtHour": 0,
  "emailDayOfWeek": 0,
  "emailDayOfMonth": 0,
  "emailStart": "2023-10-12T07:10:17Z",
  "emailEnd": "2023-10-12T07:10:17Z",
  "emailLastSend": "2023-10-12T07:10:17Z",
  "nextAppointment": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
rank	integer	false	none	none
start	string(date-time)	false	none	none
recencyDays	integer	false	none	none
showContactList	boolean	false	none	none
showDenialReasons	boolean	false	none	none
showClientOrigins	boolean	false	none	none
showInquiries	boolean	false	none	none
showEvents	boolean	false	none	none
showTimeSpent	boolean	false	none	none
showPublication	boolean	false	none	none
showEventContent	boolean	false	none	none
showPhases	boolean	false	none	none
showOffers	boolean	false	none	none
status	string	false	none	none
emailFrequency	string	false	none	none
emailAtHour	integer	false	none	none
emailDayOfWeek	integer	false	none	none
emailDayOfMonth	integer	false	none	none
emailStart	string(date-time)	false	none	none
emailEnd	string(date-time)	false	none	none
emailLastSend	string(date-time)	false	none	none
nextAppointment	string(date-time)	false	none	none

PropertyReportComment

{
  "id": 0,
  "datetime": "2023-10-12T07:10:17Z",
  "txt": "string",
  "html": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
datetime	string(date-time)	false	none	none
txt	string	false	none	none
html	string	false	none	none

PropertyReportEmailrecipient

{
  "id": 0,
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
rank	integer	false	none	none

PropertyReportViewer

{
  "id": 0,
  "rank": 0,
  "lastViewed": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
rank	integer	false	none	none
lastViewed	string(date-time)	false	none	none

PropertyTag

{
  "id": 0,
  "name": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
name	string	false	none	none

PropertyUtility

{
  "id": 0,
  "slug": "string",
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
slug	string	false	none	none
rank	integer	false	none	none

SearchprofileTemplate

{
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none

SearchprofileTemplateCategory

{
  "id": 0,
  "slug": "string",
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
slug	string	false	none	none
rank	integer	false	none	none

SearchprofileTemplateFeature

{
  "id": 0,
  "slug": "string",
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
slug	string	false	none	none
rank	integer	false	none	none

SearchprofileTemplateUtility

{
  "id": 0,
  "slug": "string",
  "rank": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
slug	string	false	none	none
rank	integer	false	none	none

ServiceCredit

{
  "id": 0,
  "provider": "string",
  "product": "string",
  "package": "string",
  "amount": 0,
  "variants": 0,
  "validFrom": "2023-10-12T07:10:17Z",
  "validUntil": "2023-10-12T07:10:17Z",
  "verified": "2023-10-12T07:10:17Z",
  "price": 0,
  "currency": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
provider	string	false	none	none
product	string	false	none	none
package	string	false	none	none
amount	integer	false	none	none
variants	integer	false	none	none
validFrom	string(date-time)	false	none	none
validUntil	string(date-time)	false	none	none
verified	string(date-time)	false	none	none
price	integer	false	none	none
currency	string	false	none	none

ServiceRequest

{
  "id": 0,
  "reference": "string",
  "requestHash": "string",
  "provider": "string",
  "product": "string",
  "resultJSON": null,
  "resultFile": "string",
  "request": null,
  "format": null
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
reference	string	false	none	none
requestHash	string	false	none	none
provider	string	false	none	none
product	string	false	none	none
resultJSON	any	false	none	none
resultFile	string	false	none	none
request	any	false	none	none
format	any	false	none	none

Subsidiary

{
  "id": "string",
  "rank": 0,
  "casaauthCompanyId": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
rank	integer	false	none	none
casaauthCompanyId	string	false	none	none

SubsidiaryPublisherOption

{
  "id": 0,
  "rank": 0,
  "optionKey": "string",
  "optionValue": "string",
  "gatewayPublisher": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
rank	integer	false	none	none
optionKey	string	false	none	none
optionValue	string	false	none	none
gatewayPublisher	string	false	none	none

Template

{
  "id": "string",
  "rank": 0,
  "name": "string",
  "subject": "string",
  "lang": "string",
  "txt": "string",
  "html": "string",
  "status": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	string	false	none	none
rank	integer	false	none	none
name	string	false	none	none
subject	string	false	none	none
lang	string	false	none	none
txt	string	false	none	none
html	string	false	none	none
status	string	false	none	none

User

{
  "username": "string",
  "role": "string",
  "firstCheckIn": "2023-10-12T07:10:17Z",
  "filterPresets": null,
  "completedTours": null,
  "sendInquiryNotificationEmails": true,
  "sendPushNotifications": true,
  "status": "string",
  "lastRoute": "string",
  "nylasAuthRequest": "2023-10-12T07:10:17Z"
}

Properties

Name	Type	Required	Restrictions	Description
username	string	false	none	none
role	string	false	none	none
firstCheckIn	string(date-time)	false	none	none
filterPresets	any	false	none	none
completedTours	any	false	none	none
sendInquiryNotificationEmails	boolean	false	none	none
sendPushNotifications	boolean	false	none	none
status	string	false	none	none
lastRoute	string	false	none	none
nylasAuthRequest	string(date-time)	false	none	none

UserEmailSetting

{
  "id": 0
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none

UserSignature

{
  "id": 0,
  "rank": 0,
  "name": "string",
  "signature": "string"
}

Properties

Name	Type	Required	Restrictions	Description
id	integer	false	none	none
rank	integer	false	none	none
name	string	false	none	none
signature	string	false	none	none