JAjane
Company

Get details about the company

Changed on

Retrieve details about the company

get/api/2026-01-01/company

Request

  • Base URL
    https://jdpdocsdemo.jane.qa
  • URL
    https://jdpdocsdemo.jane.qa/api/2026-01-01/company
  • Auth
    OAuth 2
    Authorization code: https://login.id.janeapp.com/realms/jane_partner_sandbox/protocol/openid-connect/auth?response_type=code&resource=https://jdpdocsdemo.jane.qa&prompt=consent
    Token URL: https://login.id.janeapp.com/realms/jane_partner_sandbox/protocol/openid-connect/token scopes: companies:read

Response

The company details

idstring

Unique identifier for the company

namestring

Company name

legal_namestring

Company legal name

jane_urlstring

Jane URL

logo_urlstring

Company logo url

online_booking_enabledboolean

Online booking enabled

localestring

Locale. Ex. en, en-IN, fr-CA, etc.

emailstring

Email

phone_numberstring

Phone number

currency_formatstring

Currency format. Ex. en, en-IN, fr-CA, etc.

time_zonestring

Time zone. Ex. America/Vancouver

theme_primary_colorstring

Hexadecimal theme primary color. Ex. #00c1ca

theme_secondary_colorstring

Hexadecimal theme secondary color. Ex. #00c1ca

street_addressstring

Street address

street_address_2string

Street address 2

citystring

City

provincestring

Province

postalstring

Postal code

countrystring

Country

map_coordinatesstring

Map coordinates. Format: latitude,longitude

clinic_open_hourinteger nullable

Hour the clinic opens, as an hour of the day in 24h format (0–23). Null if not configured.

clinic_close_hourinteger nullable

Hour the clinic closes, as an hour of the day in 24h format (0–23). Null if not configured.

Changes

  • 01798f613a5eRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status