company

GET /api/3.0/company

Retrieve company configuration information of the system you are connecting to.

Response JSON Object:
 
  • url (string) – The Checkfront URL of the account.
  • name (string) – The display name of the company.
  • plan_id (integer) – The Checkfront subscription plan ID of the account.
  • email (string) – The contact email address of the company.
  • address (string) – The street address of the company.
  • city (string) – The city where the company is located.
  • postal_zip (string) – The postal or zip code of the company.
  • region (string) – The state/province of the company.
  • region_id (string) – The state/province of the company.
  • country_id (string) – The country where the company is based.
  • currency_id (string) – The currency type accepted by the company.
  • timezone (string) – The timezone of the company.
  • locale_id (string) – The locale string set for the company.
  • lang_id (string) – The ISO 639-1 language code of the company.
  • date_format (string) – The date format set for the company.
  • time_format (string) – The time format set for the company.
 
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
{
    "version": "3.0",
    "account_id": 1,
    "host_id": "your-company.checkfront.com",
    "name": "Your Company",
    "locale": {
        "id": "en_US",
        "lang": "_en",
        "currency": "CAD"
    },
    "request": {
        "status": ""
    },
    "query": false,
    "category": {
        "2": {
            "category_id": 2,
            "name": "Accommodation",
            "pos": 2,
            "qty": 0,
            "unit": "N"
        },
        "3": {
            "category_id": 3,
            "name": "Tours",
            "pos": 5,
            "qty": 0,
            "unit": "N"
        },
        "4": {
            "category_id": 4,
            "name": "Rentals",
            "pos": 0,
            "qty": 0,
            "unit": "N"
        }
    }
}