id |
string |
Identifier of the company. |
name |
string |
Name of the company. Max length 127. |
timeZone |
string |
The time zone of the company. Possible values can be found here. |
email |
string |
Email address of the company. Max length 127. |
phone |
string |
Phone number of the company. Max length 127. |
address |
object |
Postal address of the company. |
address.street |
string |
Main street address. Max length 127. |
address.otherStreet |
string |
Optional street address. Max length 127. |
address.zipCode |
string |
Zip code of address. Max length 127. |
address.state |
string |
State of address. Max length 127. |
address.city |
string |
City of address. Max length 127. |
address.country |
string |
Country of address. ISO 3166-1 alpha-2 code. |
description |
string |
Description of the company. HTML code allowed. |
picture |
object |
Company picture url and mime type. |
picture.url |
string |
Url of the company picture. |
picture.mimeType |
string |
Mime type of the company picture file. |
photo |
object |
Company photo url and mime type. |
photo.url |
string |
Url of the company photo. |
photo.mimeType |
string |
Mime type of the company photo file. |
geolocation |
object |
Company geolocation coordinates. |
geolocation.lat |
float |
Latitude coordinate. |
geolocation.lng |
float |
Longitude coordinate. |
workingHours |
list |
Working hours of the company. |
currency |
string |
Currency of the company for online payments. Values: "USD", "CAD", "EUR", "GBP", "DKK" or "JPY". Max length 5. |
vacations |
list |
Vacation dates of the company. |
vacations[].startDate |
string |
Start date of the vacation period, in the format "yyyy/mm/dd" |
vacations[].endDate |
string |
End date of the vacation period, in the format "yyyy/mm/dd" |
websiteLink |
string |
Web site address (URL) of the company. Max length 65535. |
scheduledItems |
string |
Scheduled items of the company. Values: "service", "service-staff", "staff-service", "resource", "quickStart" |
businessCategory |
list |
Business category of the company. Retreive category list with this API. Max length 100. |
updated |
object |
The last updated time of the company. |
end.dateTime |
string |
The time, as a combined date-time value (formatted according to RFC 3339, without time zone information). |
end.timeZone |
string |
The time zone. Possible values can be found here. The default value is the time zone of the company. |
externalId |
string |
Unique company identifier from another (external) system. Max length 255. |
externalCalendars |
list |
ICS external calendar URL. |
externalCalendars[].address |
string |
Address of the ICS URL. |
socialMedias |
object |
Social medias |
socialMedias.facebookPageLink |
string |
Link to Facebook page |
socialMedias.twitteLink |
string |
Link to Twitter |
socialMedias.instagramLink |
string |
Link to Instagram |
socialMedias.linkedInLink |
string |
Link to LinkedIn |
| extendedProperties | object |
Extended Properties. You can defined your custom properties. Size limit: 22KB. |
| extendedProperties.private | object |
Private properties. These properties are not retrieve in widget. |
| extendedProperties.public | object |
Private properties. These properties are retrieve in widget. |
Returns all companies of child accounts of a reseller account.
Authentication is required to execute this request. Please refer to Authentication for more.
Do not supply a request body with this method.
If successful, this method returns a list of Company resource in the response body.