Agendize Resellers API

Companies

Resource representation

{ "id": {string}, "name": {string}, "timeZone": {string}, "email": {string}, "phone": {string}, "address": { "street": {string}, "otherStreet": {string}, "zipCode": {string}, "state": {string}, "city": {string}, "country" : {string} }, "description": {string}, "geolocation": { "lat": {float}, "lng": {float} }, "picture": { "url": {string}, "mimeType": {string} }, "photo": { "url": {string}, "mimeType": {string} }, "workingHours": [ { "day": "sunday", "hours": [ { "start": {string}, "end": {string} } ] }, { "day": "monday", "hours": [ { "start": {string}, "end": {string} } ] }, { "day": "tuesday", "hours": [ { "start": {string}, "end": {string} } ] }, { "day": "wednesday", "hours": [ { "start": {string}, "end": {string} } ] }, { "day": "thursday", "hours": [ { "start": {string}, "end": {string} } ] }, { "day": "friday", "hours": [ { "start": {string}, "end": {string} } ] }, { "day": "saturday", "hours": [ { "start": {string}, "end": {string} } ] } ], "currency": {string}, "vacations": [ { "startDate": {string}, "endDate": {string} } ], "websiteLink": {string}, "scheduledItems": {string}, "businessCategory": {string}, "updated": { "dateTime": {datetime}, "timeZone": {string} }, "externalId": {string}, "externalCalendars": [ { "address": {string}, "type": "ics" ], "socialMedias: { "facebookPageLink: {string}, "twitteLink": {string}, "instagramLink: {string}, "linkedInLink": {string} }, "extendedProperties": { "private": {object}, "public": {object} }, "created": { "dateTime": {string}, "timeZone": {string} } }

Parameter name	Value	Description
`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.
`workingHours[].sunday`	`list`	List of working hours for sunday. Only if hours are defined for the day.	writable
`workingHours[].sunday[].start`	`string`	Start hour. Format: HH:mm.	writable
`workingHours[].sunday[].end`	`string`	End hour. Format: HH:mm.	writable
`workingHours[].monday`	`list`	List of working hours for monday. Only if hours are defined for the day.	writable
`workingHours[].monday[].start`	`string`	Start hour. Format: HH:mm.	writable
`workingHours[].monday[].end`	`string`	End hour. Format: HH:mm.	writable
`workingHours[].tuesday`	`list`	List of working hours for tuesday. Only if hours are defined for the day.	writable
`workingHours[].tuesday[].start`	`string`	Start hour. Format: HH:mm.	writable
`workingHours[].tuesday[].end`	`string`	End hour. Format: HH:mm.	writable
`workingHours[].wednesday`	`list`	List of working hours for wednesday. Only if hours are defined for the day.	writable
`workingHours[].wednesday[].start`	`string`	Start hour. Format: HH:mm.	writable
`workingHours[].wednesday[].end`	`string`	End hour. Format: HH:mm.	writable
`workingHours[].thursday`	`list`	List of working hours for thursday. Only if hours are defined for the day.	writable
`workingHours[].thursday[].start`	`string`	Start hour. Format: HH:mm.	writable
`workingHours[].thursday[].end`	`string`	End hour. Format: HH:mm.	writable
`workingHours[].friday`	`list`	List of working hours for friday. Only if hours are defined for the day.	writable
`workingHours[].friday[].start`	`string`	Start hour. Format: HH:mm.	writable
`workingHours[].friday[].end`	`string`	End hour. Format: HH:mm.	writable
`workingHours[].saturday`	`list`	List of working hours for saturday. Only if hours are defined for the day.	writable
`workingHours[].saturday[].start`	`string`	Start hour. Format: HH:mm.	writable
`workingHours[].saturday[].end`	`string`	End hour. Format: HH:mm.	writable
`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.
`created`	`object`	The created date time of the company.	read-only
`created.dateTime`	`string`	The time, as a combined date-time value (formatted according to RFC 3339, without time zone information).
`created.timeZone`	`string`	The time zone. Possible values can be found here. The default value is the time zone of the company.

List

Returns all companies of child accounts of a reseller account.

Authentication is required to execute this request. Please refer to Authentication for more.

Request

HTTP Request

GET https://api.agendize.com/api/2.1/resellers/scheduling/companies

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a list of Company resource in the response body.

{ items: [Company Resource] }