GET organisation/general_settings/show

Available from CRM.COM R12.0.0

This method returns the general settings related with the organisation of the logged in user

Resource URL

Parameters

Name	Type	Description
token	String	The token retrieved from the login method
fields_set (optional)	List of Strings, comma separated	A list of fields that should be included in the results. If not specified then all the available fields will be returned

Response Data

Name	Type	Description
default_system_language	String	The default system language of the organisation
maximum_file_size	Number	The maximum size of files which are allowed to be uploaded (in KB)
allowed_file_types	String	The type of files which are allowed to be uploaded
multi_country_business_network	Boolean	Defines whether the multi-country business network is enabled Available from CRM.COM R18.0.0
default_country	Country Object	The default country of the organisation
default_currency	Currency Object	The default currency of the organisation
time_zone	Timezone Object	The timezone of the organisation
contact_information	Contact Information Object	The contact information related with the organisation Available from CRM.COM R15.2.0
supported_languages_set	Set of Language Objects	The languages that are supported by the organisation Available from CRM.COM R13.0.0
supported_countries_set	Set of Country Objects	The countries that are supported by the organisation Available from CRM.COM Rx

Referred Objects Response Data

contact_information object response data

Name	Type	Description
id	String	The ID of the retrieved contact information
type	String	The type of the retrieved contact information which can be PERSON or COMPANY
life_cycle_state	String	The lifecycle state of the retrieved contact information which can be MARKETING or FINANCIAL
name	String	The full name of the retrieved contact information
first_name	String	The first name of the retrieved contact information
middle_name	String	The middle name of the retrieved contact information
last_name	String	The last name of the retrieved contact information
title	String	The title of the retrieved contact information
company_name	Sting	The company name of the retrieved contact information
demographics	Demographics Object	The demographics information of the retrieved contact information
company_profile	Company profile object	The company profile of the retrieve contact information

Referred Objects Response Data

demographics object response data

Name	Type	Description
gender	String	The gender of the retrieved contact information which can be MALE or FEMALE
id_number	String	The ID number of the retrieved contact information
id_number_expiration_date	Date	The ID number's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
passport_number	String	The passport number of the retrieved contact information
passport_number_expiration_date	Date	The passport's expiration date of the retrieved contact information Available from CRM.COM R14.0.0
social_security_number	String	The social security number of the retrieved contact information
date_of_birth	Date of Birth Object	The date of birth of the retrieved contact information
name_day	Name Day Object	The name day of the retrieved contact information
country_of_residence	Country Object	The country of residence of the retrieved contact information
id_issued_by_country	Country Object	The ID issued country of retrieved contact information
passport_issued_by_country	Country Object	The passport issued country of retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

date_of_birth object response data

Name	Type	Description
day	Integer	The day of the retrieved date of birth
month	Integer	The month of the retrieved date of birth
year	Integer	The year of the retrieved date of birth

name_day object response data

Name	Type	Description
day	Integer	The day of the retrieved name day
month	Integer	The month of the retrieved name day

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

company profile object response data

Name	Type	Description
profile_year	Number	The profile year of the retrieved contact information
annual_turnover	Number	The annual turnover of the retrieved contact information
established_date	Date	The established date of the retrieved contact information
number_of_employees	Number	The number of employees of the retrieved contact information
registration_number	String	The registration number of the retrieved contact information
vat_registration_number	String	The vat registration number of the retrieved contact information
vat_registered_by	String	The vat registration by of the retrieved contact information
vat_registration_date	Date	The vat registration date of the retrieved contact information
tax_reference_number	String	The tax referenece number of the retrieved contact information
registered_in_country	Country Object	The country of residence of the retrieved contact information
industry	Industry Object	The industry of retrieved contact information
industry_sector	Industry sector Object	The sector of retrieved contact information

Referred Objects Response Data

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

industry object response data

Name	Type	Description
id	String	The id of the retrieved industry
name	String	The name of the retrieved industry
code	String	The code of the retrieved industry

industry sector object response data

Name	Type	Description
id	String	The id of the retrieved industry sector
name	String	The name of the retrieved industry sector
alternative_code	String	The alternative code of the retrieved industry sector

country object response data

Name	Type	Description
id	String	The id of the retrieved country
name	String	The name of the retrieved country
alternative_code	String	The alternative code of the retrieved country
dialing_code	String	The dialing code of the retrieved country Available from CRM.COM R15.1.0
two_character_code	String	The two character code of the retrieved country
three_character_code	String	The three character code of the retrieved country
country_flag	Image Object	The flag of the retrieved country Available from CRM.COM R15.1.0

Referred Objects Response Data

country_flag object response data

Name	Type	Description
id	String	The ID of the retrieved country flag
file	File Object	The information of the attached file

Referred Objects Response Data

file object response data

Name	Type	Description
file_name	String	The name of the file
file_content_url	String	The url that can be used to access the actual content of the file
file_mime_type	String	The mime type of the attached file

currency object response data

Name	Type	Description
id	String	The ID of the retrieved currency
code	String	The code of the retrieved currency
prefix_symbol	String	The prefix symbol for the specified currency
suffix_symbol	String	The suffix symbol for the specified currency
life_cycle_state	String	The life cycle state for the specified currency, which can be EFFECTIVE or NOT EFFECTIVE Available from CRM.COM R14.0.0
integer_part_name	String	The integer part name for the specified currency
decimal_part_name	String	The decimal part name for the specified currency

timezone object response data

Name	Type	Description
region	String	The region that is represented by the selected timezone
utc_offset_in_minutes	Integer	The selected timezone offset in relation to UTC in minutes

lanugage object response data

Name	Type	Description
language	String	The language supported by the organisation

Examples

Example 1

HTTP Method: GET

Request:

Response:

 {
  "data": {
    "maximum_file_size": "200",
    "allowed_file_types": ".jpg,.xls,.doc,.xlf,.png,.csv,.xml",
    "default_system_language": "SPA",
    "default_currency": {
      "suffix_symbol": "N/A",
      "prefix_symbol": "€",
      "decimal_part_name": "cents",
      "code": "EUR",
      "integer_part_name": "euro",
      "id": "2"
    },
    "time_zone": {
      "utc_offset_in_minutes": 120,
      "region": "Europe/Athens"
    },
    "default_country": {
      "alternative_code": "CYP",
      "three_character_code": "CYP",
      "name": "CYPRUS",
      "id": "181",
      "two_character_code": "CY"
    }
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

Example 2

HTTP Method: GET

Request:

Response:

 {
  "data": {
    "time_zone": {
      "utc_offset_in_minutes": 120,
      "region": "Europe/Athens"
    }
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}

Example 3

HTTP Method: GET

Request:

Response:

 {
  "data": {
    "supported_languages_set": [
      {
        "language": "ARA"
      },
      {
        "language": "CMN"
      },
      {
        "language": "CUSTOM1"
      },
      {
        "language": "CUSTOM2"
      },
      {
        "language": "CUSTOM3"
      },
      {
        "language": "CUSTOM4"
      },
      {
        "language": "CUSTOM5"
      },
      {
        "language": "CUSTOM6"
      },
      {
        "language": "CUSTOM7"
      },
      {
        "language": "CUSTOM8"
      },
      {
        "language": "DAN"
      },
      {
        "language": "DEU"
      },
      {
        "language": "ELL"
      },
      {
        "language": "ENG"
      },
      {
        "language": "EST"
      },
      {
        "language": "FIN"
      },
      {
        "language": "FRA"
      },
      {
        "language": "HIN"
      },
      {
        "language": "IND"
      },
      {
        "language": "JPN"
      },
      {
        "language": "LAV"
      },
      {
        "language": "LIT"
      },
      {
        "language": "MAL"
      },
      {
        "language": "NNO"
      },
      {
        "language": "POL"
      },
      {
        "language": "POR"
      },
      {
        "language": "RUS"
      },
      {
        "language": "SPA"
      },
      {
        "language": "SWE"
      },
      {
        "language": "TAI"
      },
      {
        "language": "TGL"
      },
      {
        "language": "UKR"
      },
      {
        "language": "VIE"
      }
    ],
    "maximum_file_size": "1000",
    "allowed_file_types": ".jpg,.xls,.doc,.png,.xlf,.csv,.zip,xlsx",
    "default_system_language": "ENG",
    "default_currency": {
      "suffix_symbol": null,
      "prefix_symbol": "€",
      "decimal_part_name": null,
      "code": "EUR",
      "integer_part_name": null,
      "id": "2"
    },
    "time_zone": {
      "utc_offset_in_minutes": 270,
      "region": "Iran"
    },
    "default_country": {
      "alternative_code": "CYP",
      "three_character_code": "CYP",
      "name": "CYPRUS",
      "id": "181",
      "two_character_code": "CY"
    }
  },
  "status": {
    "code": "OK",
    "description": "",
    "message": ""
  }
}