Company administration service methods - Revision history

Admin at 16:27, 13 February 2026

2026-02-13T16:27:52Z

← Older revision		Revision as of 16:27, 13 February 2026
Line 5:		Line 5:
	{{#seo:		{{#seo:
	\|title=Company administration service methods - SimplyBook.me		\|title=Company administration service methods - SimplyBook.me
	\|description=Learn ~~about service~~ methods for ~~internal company administration~~. Manage bookings ~~tailored to your operations~~. ~~Start here!~~		\|description=Learn admin API methods documentation. Developer reference for backend operations. Manage bookings, clients, reports via API with authentication.
	\|titlemode=append		\|titlemode=append
	\|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content		\|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content

Tania at 14:14, 15 May 2025

2025-05-15T14:14:46Z

Show changes

Tania: Marked this version for translation

2025-05-15T12:57:46Z

Marked this version for translation

Show changes

Tania at 12:56, 15 May 2025

2025-05-15T12:56:49Z

← Older revision		Revision as of 12:56, 15 May 2025
Line 2,418:		Line 2,418:

	See [[Custom_Features\|Custom Features]] page for description for each Custom Feature.		See [[Custom_Features\|Custom Features]] page for description for each Custom Feature.


	</translate>		</translate>


	<translate>		<translate>


	== Examples ==		== Examples ==

Tania at 12:55, 15 May 2025

2025-05-15T12:55:48Z

← Older revision		Revision as of 12:55, 15 May 2025
Line 228:		Line 228:

	* [https://help.simplybook.me/index.php/Need_to_change_interval_(timeframe) Timeframe information]		* [https://help.simplybook.me/index.php/Need_to_change_interval_(timeframe) Timeframe information]


	</translate>		</translate>

	----		----
	<translate>		<translate>

	=== calculateEndTime ===		=== calculateEndTime ===

Tania at 12:55, 15 May 2025

2025-05-15T12:55:04Z

← Older revision		Revision as of 12:55, 15 May 2025
Line 229:		Line 229:
	* [https://help.simplybook.me/index.php/Need_to_change_interval_(timeframe) Timeframe information]		* [https://help.simplybook.me/index.php/Need_to_change_interval_(timeframe) Timeframe information]

			</translate>
	----		----
	~~</translate>~~

	<translate>		<translate>


	=== calculateEndTime ===		=== calculateEndTime ===

Tania at 12:54, 15 May 2025

2025-05-15T12:54:01Z

← Older revision		Revision as of 12:54, 15 May 2025
Line 23:		Line 23:
	* <code>params</code> - An Array of objects to be passed as parameters to the defined method.		* <code>params</code> - An Array of objects to be passed as parameters to the defined method.
	* <code>id</code> - A value of any type, which is used to match the response with the request that it is replying to.		* <code>id</code> - A value of any type, which is used to match the response with the request that it is replying to.

	</translate>		</translate>

	<translate>		<translate>

	The receiver of the request must reply with a valid response to all received requests. A response must contain the properties mentioned below.		The receiver of the request must reply with a valid response to all received requests. A response must contain the properties mentioned below.

Line 33:		Line 31:
	* <code>error</code> - A specified error code if there was an error invoking the method, otherwise null.		* <code>error</code> - A specified error code if there was an error invoking the method, otherwise null.
	* <code>id</code> - The id of the request it is responding to.		* <code>id</code> - The id of the request it is responding to.

	</translate>		</translate>

	<translate>		<translate>

	Example		Example

Line 74:		Line 70:
	}		}
	</pre>		</pre>

	</translate>		</translate>

	<translate>		<translate>

	Example of request with error response:		Example of request with error response:

Line 100:		Line 94:
	}		}
	</pre>		</pre>

	</translate>		</translate>

	<translate>		<translate>

	All calls of public service methods should have additional HTTP header:		All calls of public service methods should have additional HTTP header:

Line 116:		Line 108:

	Using Simplybook API methods require an authentification. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method <code>[[Authentication#getUserToken\|getUserToken]]</code> API method on https://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Custom Features' link and select [[Custom_Features#API\|API Custom Feature]] 'Settings'.		Using Simplybook API methods require an authentification. To authorize in Simplybook API you need to get an access key — access-token. In order to get this access-token you should call the JSON-RPC method <code>[[Authentication#getUserToken\|getUserToken]]</code> API method on https://user-api.simplybook.me/login service passing your personal API-key. You can copy your API-key at admin interface: go to the 'Custom Features' link and select [[Custom_Features#API\|API Custom Feature]] 'Settings'.

	~~== Methods ==~~

	== Methods ==		== Methods ==
Line 158:		Line 148:
	zip: 3872		zip: 3872
	}		}


	</translate>		</translate>

	<translate>		<translate>

	----		----

Tania at 12:51, 15 May 2025

2025-05-15T12:51:45Z

← Older revision		Revision as of 12:51, 15 May 2025
Line 2,677:		Line 2,677:

	<code>service_ids</code> contains a list of services for wich promotion discount can be applied.		<code>service_ids</code> contains a list of services for wich promotion discount can be applied.
	~~-->~~
	</translate>		</translate>

Tania at 12:51, 15 May 2025

2025-05-15T12:51:13Z

← Older revision		Revision as of 12:51, 15 May 2025
Line 8:		Line 8:
	\|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content		\|keywords=faq, frequently asked questions, booking software, appointment system questions, appointments online, calendar software, booking system, booking calendar, scheduling software, online appointment scheduling, online scheduling, setup, setup help, support, help content
	}}		}}

	</translate>		</translate>

	<translate>		<translate>

	==General Information==		==General Information==

Line 2,636:		Line 2,634:
	* classic		* classic
	* classes		* classes


	</translate>		</translate>



	<translate>		<translate>

	Please note that <code>classic</code> timeline type is deprecated and not supported anymore.		Please note that <code>classic</code> timeline type is deprecated and not supported anymore.

Line 2,649:		Line 2,643:

	For information about <code> timeframe</code>, <code>timezone</code>, <code>allow_event_day_break</code> and <code>allow_event_breaktime_break</code> see [[#Company params\|Company params section]].		For information about <code> timeframe</code>, <code>timezone</code>, <code>allow_event_day_break</code> and <code>allow_event_breaktime_break</code> see [[#Company params\|Company params section]].
	~~----~~

	</translate>		</translate>

	----		----

Line 2,686:		Line 2,678:
	<code>service_ids</code> contains a list of services for wich promotion discount can be applied.		<code>service_ids</code> contains a list of services for wich promotion discount can be applied.
	-->		-->

	</translate>		</translate>

Tania at 12:47, 15 May 2025

2025-05-15T12:47:10Z

← Older revision		Revision as of 12:47, 15 May 2025
Line 2,436:		Line 2,436:
	</translate>		</translate>

	~~----~~

	<translate>		<translate>
Line 2,516:		Line 2,515:
	</translate>		</translate>

	~~----~~

	<translate>		<translate>


	Location field is present in response only if [[Custom_Features#Multiple_Locations\|Multiple locations Custom Feature]] is enabled. Otherwise this field will be an empty array. If locations Custom Feature is enabled but booking doesn't have any locations this fields also will be an empty array.		Location field is present in response only if [[Custom_Features#Multiple_Locations\|Multiple locations Custom Feature]] is enabled. Otherwise this field will be an empty array. If locations Custom Feature is enabled but booking doesn't have any locations this fields also will be an empty array.