ONonsched
Companies

Get Company

Use this endpoint to return the Authorized Company information. The company is the main entity that oversees all business locations defined below it, hierarchically.

Access to the company credentials gives you access to all business locations defined in the authorized company. Client credentials resolve to a single company and are purposely hidden from this endpoint.

get/setup/v1/companies

Request

Response

Success

objectstring nullable
idstring nullable
namestring nullable
registrationDatestring nullable
registrationEmailstring nullable
deletedStatusboolean
deletedTimestring nullable
addressLine1string nullable
addressLine2string nullable
citystring nullable
statestring nullable
postalCodestring nullable
countrystring nullable
phonestring nullable
faxstring nullable
emailstring nullable
websitestring nullable
timezoneIdstring nullable
timezoneNamestring nullable
notificationFromEmailAddressstring nullable
notificationFromNamestring nullable
clientIdstring nullable
clientSecretstring nullable
bookingWebhookUrlstring nullable
customerWebhookUrlstring nullable
reminderWebhookUrlstring nullable
resourceWebhookUrlstring nullable
webhookSignatureHashstring nullable
disableEmailAndSmsNotificationsboolean

Changes

No recorded changes to this operation across all 1 revision of this API.