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    "version": "3.0",
 3    "account_id": 1,
 4    "host_id": "your-company.checkfront.com",
 5    "name": "Your Company",
 6    "locale": {
 7        "id": "en_GB",
 8        "lang": "en",
 9        "currency": "CAD"
10    },
11    "request": {
12        "status": "OK",
13        "resource": "company",
14        "records": 19,
15        "limit": 0,
16        "page": 1,
17        "pages": 1,
18        "time": 0.0016,
19        "method": "get"
20    },
21    "company": {
22        "url": "your-company.checkfront.com",
23        "name": "Your Company",
24        "plan_id": 1,
25        "email": "hello@checkfront.com",
26        "address": "",
27        "city": "",
28        "postal_zip": "",
29        "region": "LND",
30        "country_id": "CA",
31        "currency_id": "CAD",
32        "timezone": "Canada/Pacific",
33        "locale_id": "en_GB",
34        "lang_id": "en",
35        "date_format": "%m/%d/%y",
36        "time_format": "%I:%M %p",
37        "phone": "",
38        "utc_offset": -7,
39        "currency": {
40            "symbol": "$",
41            "symbol_space": 0,
42            "symbol_precedes": 1,
43            "decimals": 2,
44            "decimal_separator": ".",
45            "thousands_separator": ","
46        }
47    },
48    "hours": false
49}