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.

Public API

If the Public API is enabled, unauthenticated users can make requests to the /company endpoint. Both the public and authenticated responses are identical.

 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
39
40
41
42
43
44
45
46
47
48
49
{
    "version": "3.0",
    "account_id": 1,
    "host_id": "your-company.checkfront.com",
    "name": "Your Company",
    "locale": {
        "id": "en_GB",
        "lang": "en",
        "currency": "CAD"
    },
    "request": {
        "status": "OK",
        "resource": "company",
        "records": 19,
        "limit": 0,
        "page": 1,
        "pages": 1,
        "time": 0.0016,
        "method": "get"
    },
    "company": {
        "url": "your-company.checkfront.com",
        "name": "Your Company",
        "plan_id": 1,
        "email": "hello@checkfront.com",
        "address": "",
        "city": "",
        "postal_zip": "",
        "region": "LND",
        "country_id": "CA",
        "currency_id": "CAD",
        "timezone": "Canada/Pacific",
        "locale_id": "en_GB",
        "lang_id": "en",
        "date_format": "%m/%d/%y",
        "time_format": "%I:%M %p",
        "phone": "",
        "utc_offset": -7,
        "currency": {
            "symbol": "$",
            "symbol_space": 0,
            "symbol_precedes": 1,
            "decimals": 2,
            "decimal_separator": ".",
            "thousands_separator": ","
        }
    },
    "hours": false
}