Services

Resource representation

{ "id": {string}, "name": {string}, "duration": {integer}, "bufferDuration": {integer}, "bufferBeforeDuration": {integer}, "price": {float}, "payable": {boolean}, "color": {color}, "description": {string}, "picture": { "url": {string}, "mimeType": {string} }, "staff": [ { "id": {string}, "firstName": {string}, "lastName": {string}, "price": {string} } ], "availableForWidget": {boolean}, "maxAppointmentsPerDay": {integer}, "externalId": {string} }

Parameter name	Value	Description
`id`	`string`	Identifier of the service.
`name`	`string`	Name of the service.	writable
`duration`	`integer`	Service duration, in minutes.	writable
`bufferDuration`	`integer`	Buffer's duration after service, in minutes.	writable
`bufferBeforeDuration`	`integer`	Buffer's duration before service, in minutes.	writable
`price`	`float`	Service pricing.	writable
`payable`	`boolean`	Sets if the client can pay with paypal.	writable
`color`	`string`	Service color, for dashboard displaying. Hexadecimal web color. Default Color: #EFEFEF.	writable
`description`	`string`	Description of the service.	writable
`staff`	`list`	List of staff members who have the skills for the service.	writable
`picture`	`object`	Service picture url and mime type.	writable
`picture.url`	`string`	Url of the service picture.
`picture.mimeType`	`string`	Mime type of the service picture file.	writable
`availableForWidget`	`boolean`	Sets if the service is available for online scheduling. Default value: true	writable
`maxAppointmentsPerDay`	`boolean`	Sets how many appointments a client can book per day. Default value: 0 (no limit)	writable
`externalId`	`string`	Unique service identifier from another (external) system.

Delete

Deletes an entry on the company's service list.

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

Request

HTTP Request

DELETE https://api.agendize.com/api/2.0/scheduling/companies/{companyId}/services/{serviceId}


Parameters

	
		
			Parameter name
			Value
			Description
		
	
	
		
			Path parameters
		
		
			companyId
			string
			Company identifier.
		
		
			serviceId
			string
			Service identifier or external id of service.
		
	

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 company's service list.
Authentication is required to execute this request. Please refer to Authentication for more.
Request
HTTP Request
GET https://api.agendize.com/api/2.0/scheduling/companies/{companyId}/services/{serviceId}
Parameters

	
		
			Parameter name
			Value
			Description
		
	
	
		
			Path parameters
		
		
			companyId
			string
			Company identifier.
		
		
			serviceId
			string
			Service identifier or external id of service.
		
		
			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 Service resource in the response body.


List
Returns entries on the company's service list.
Authentication is required to execute this request. Please refer to Authentication for more.
Request
HTTP Request
GET https://api.agendize.com/api/2.0/scheduling/companies/{companyId}/services
Parameters

	
		
			Parameter name
			Value
			Description
		
	
	
		
			Path parameters
		
		
			companyId
			string
			Company identifier.
		
		
			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:
		[Service Resource]
}



Insert
Adds an entry to the company's service list.
Authentication is required to execute this request. Please refer to Authentication for more.
Request
HTTP Request
POST https://api.agendize.com/api/2.0/scheduling/companies/{companyId}/services
Parameters

	
		
			Parameter name
			Value
			Description
		
	
	
		
			Path parameters
		
		
			companyId
			string
			Company identifier.
		
	

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

	
		
			Parameter name
			Value
			Description
		
	
	
		
			Required Properties
		
		
			name
			string
			Name of the service.
		
		
			Optional Properties
		
		
			duration
			integer
			Service duration, in minutes. The default duration is 60 minutes.
		
		
			bufferDuration
			integer
			Buffer's duration after service, in minutes. The default buffer duration is 0 minute.
		
		
			bufferBeforeDuration
			integer
			Buffer's duration before service, in minutes. The default buffer duration is 0 minute.
		
		
			price
			float
			Service pricing. Default price is 0.
		
		
			payable
			boolean
			Sets if the client can pay with paypal. The default value is false.
		
		
			color
			string
			Service color, for dashboard displaying. Format: xxxxxx. The default value is EFEFEF.
		
		
			description
			string
			Description of the service.
		
		
			staff
			list
			List of staff members who have the skills for the service.
		
		
			picture
			object
			Service picture url and mime type.
		
		
			picture.url
			string
			Url of the service picture.
		
		
			picture.mimeType
			string
			Mime type of the service picture file.
		
		
			availableForWidget
			boolean
			Sets if the service is available for online scheduling. Default value: true
		
		
			maxAppointmentsPerDay
			boolean
			Sets how many appointments a client can book per day. Default value: 0 (no limit)
		
	

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


Update
Updates an entry on the company's service list.
Authentication is required to execute this request. Please refer to Authentication for more.
Request
HTTP Request
PUT https://api.agendize.com/api/2.0/scheduling/companies/{companyId}/services/{serviceId}
Parameters

	
		
			Parameter name
			Value
			Description
		
	
	
		
			Path parameters
		
		
			companyId
			string
			Company identifier.
		
		
			serviceId
			string
			Service identifier or external id of service.
		
	

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

	
		
			Parameter name
			Value
			Description
		
	
	
		
			Optional Properties
		
		
			name
			string
			Name of the service.
		
	

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

Parameter name	Value	Description
Path parameters
`companyId`	`string`	Company identifier.
`serviceId`	`string`	Service identifier or external id of service.

Parameter name	Value	Description
Required Properties
`name`	`string`	Name of the service.
Optional Properties
`duration`	`integer`	Service duration, in minutes. The default duration is 60 minutes.
`bufferDuration`	`integer`	Buffer's duration after service, in minutes. The default buffer duration is 0 minute.
`bufferBeforeDuration`	`integer`	Buffer's duration before service, in minutes. The default buffer duration is 0 minute.
`price`	`float`	Service pricing. Default price is 0.
`payable`	`boolean`	Sets if the client can pay with paypal. The default value is false.
`color`	`string`	Service color, for dashboard displaying. Format: xxxxxx. The default value is EFEFEF.
`description`	`string`	Description of the service.
`staff`	`list`	List of staff members who have the skills for the service.
`picture`	`object`	Service picture url and mime type.
`picture.url`	`string`	Url of the service picture.
`picture.mimeType`	`string`	Mime type of the service picture file.
`availableForWidget`	`boolean`	Sets if the service is available for online scheduling. Default value: true
`maxAppointmentsPerDay`	`boolean`	Sets how many appointments a client can book per day. Default value: 0 (no limit)

Agendize Developers API

Services

Resource representation

Delete

Request

HTTP Request

Parameters

Request body

Response

Get

Request

HTTP Request

Parameters

Request body

Response

List

Request

HTTP Request

Parameters

Request body

Response

Insert

Request

HTTP Request

Parameters

Request body

Response

Update

Request

HTTP Request

Parameters

Request body

Response