Agendize Developers API

Home > Agendize Scheduling

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} } }
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.

Delete

Deletes an entry on the user's company list.

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

Request

HTTP Request

DELETE https://api.agendize.com/api/2.1/scheduling/companies/{companyId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier or external id.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.

Get

Returns an entry of the user's company list.

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

Request

HTTP Request

GET https://api.agendize.com/api/2.1/scheduling/companies/{companyId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier or external id.
Optional query parameters
fields string Specify the fields returned. Comma separated field names (ex: "id,name").

Request body

Do not supply a request body with this method.

Response

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

List

Returns entries on the company list.

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

Request

HTTP Request

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

Parameters

Parameter name Value Description
Optional query parameters
showDeleted boolean Whether to include deleted company list entries in the result. Optional. The default is false.
syncToken string Token obtained from the nextSyncToken field returned on the last page of results from the previous list request.
fields string Specify the fields returned. Comma separated field names (ex: "id,name").

Request body

Do not supply a request body with this method.

Response

If successful, this method returns a response body with the following structure:

{ items: [Company Resource] }

Insert

Adds an entry to the user's company list.

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

Request

HTTP Request

POST https://api.agendize.com/api/2.1/scheduling/companies

Request body

In the request body, supply a Company resource with the following properties:

Parameter name Value Description
Optional query parameters
calculateGeolocation boolean Calculate GPS coordonates from company's address.
Required Properties
name string Name of the company.
Optional Properties
timeZone string The time zone of the company. Possible values can be found here. The default value is "US/Eastern".
email string Email address of the company.
phone string Phone number of the company.
address object Postal address of the company.
address.street string Main street address.
address.otherStreet string Optional street address.
address.zipCode string Zip code of address.
address.state string State of address.
address.city string City of address.
address.country string Country of address. Possible values can be found here. The default value is "US".
picture object Company picture.
picture.data string Data URI of the company picture (eg: image/png;base64, xxxxx). See Data URI scheme. Max size: 1MB. If the size is exceeded the picture is ignored.
photo object Company photo.
photo.data string Data URI of the company photo (eg: image/png;base64, xxxxx). See Data URI scheme. Max size: 1MB. If the size is exceeded the picture is ignored.
geolocation object Company geolocation coordinates.
geolocation.lat float Latitude coordinate.
geolocation.lng float Longitude coordinate.
workingHours list Working hours of the company. The default working hours are not set.
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".
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

Response

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

Update

Updates an entry on the user's company list.

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

Request

HTTP Request

PUT https://api.agendize.com/api/2.1/scheduling/companies/{companyId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier or external id.

Request body

In the request body, supply a Company resource with the following properties:

Parameter name Value Description
Optional Properties
name string Name of the company.
picture object Company picture .
picture.data string Data URI of the company picture (eg: image/png;base64, xxxxx). See Data URI scheme. Max size: 1MB. If the size is exceeded the picture is ignored.
photo object Company photo .
photo.data string Data URI of the company photo (eg: image/png;base64, xxxxx). See Data URI scheme. Max size: 1MB. If the size is exceeded the picture is ignored.
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

Response

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

Watch

Watch for changes to Companies resources.

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

The watch send an Company resource in the request body

Request

HTTP Request

POST https://api.agendize.com/api/2.1/scheduling/companies/watch

Request body

{ "address": {string}, "name": {string}, "basicAuth": { "username": {string}, "password": {string} }, "httpRequestHeader": { {name}: {string} }, "schema": {object} "method": {string}, "status": {string}, "oauth2Auth": { "clientId": {string}, "clientSecret": {string}, "refreshToken": {string}, "authUrl": {string}, "accessTokenUrl": {string}, "redirectUri": {string} }, "signature": { "enabled": {boolean}, "cryptoKeyIds": [ {string} ] } }
Required Properties
address string The address where notifications are delivered for this watch.
Optional Properties
name string Name of the watch.
basicAuth string Credentials parameters for HTTP Basic authentication on the destination watch address. Only if you use this authentication method.
basicAuth.username string Username.
basicAuth.password string Password.
httpRequestHeader string Custom header parameters to send with the http request on the destination watch address.
httpRequestHeader.name string header parameter name.
schema object Custom json schema to apply for resource properties.
method string HTTP Method to use for sending content. DELETE Method doesn't accept body content.
status string Status of the watcher. Values: "enabled", "disabled"
oauth2Auth string Credentials parameters for HTTP OAuth2 authentication on the destination watch address. Only if you use this authentication method.
oauth2Auth.clientId string OAuth2 client id.
oauth2Auth.refreshToken string OAuth2 refresh token.
oauth2Auth.authUrl string OAuth2 interactive end point to initiate the generation of the refresh token.
oauth2Auth.accessTokenUrl string OAuth2 end point to generation an access token from the refresh token.
oauth2Auth.scope string OAuth2 api scope.
signature object Produces a crypto signature of the watched content.
signature.enabled boolean Sets if the signature is enabled or not.
signature.cryptoKeyIds list Arrays of string of crypto keys identifier.

Response

If successful, this method returns a watch resource in the response body.

Examples of schema:

With JSON, only for string value:

{ "schema": { "my_id_key": "{id}", "dataContent": { "givenName": "{firstName}" } } }

With string to support typed values:

{ "schema": "\"my_id_key\": ${$.id}, \"dataContent\": { \"fullName\": \"${$.firstName} ${$.lastName}\"}" }

Replacement string can by defined with jsonpath expressions.

Watch event supported

  • Company added in dashboard. In this case, the watch request add the following header property in http request:
    X-Agendize-objectEvent: created
  • Company modified in dashboard. In this case, the watch request add the following header property in http request:
    X-Agendize-objectEvent: updated

Agendize | Support | Status

Last update: Mar 18, 2024 - Copyright © 2024 Agendize. All rights reserved.