Home > Agendize Scheduling

Staff


Resource representation

{ "id": {string}, "firstName": {string}, "lastName": {string}, "gender": {string}, "title": {string}, "email": {string}, "phone": {string}, "otherPhone": {string}, "color": {string}, "description": {string}, "picture": { "url": {string}, "mimeType": {string} } "workingHours": [ { "day": "monday", "hours": [ { "start": "09:00", "end": "18:00" } ] } ], "services": [ { "id": {string}, "name": {string} } ], "vacations": [ { "startDate": {string}, "endDate": {string} } ], "availableForWidget": {boolean}, "role": {string}, "updated": { "dateTime": {datetime}, "timeZone": {string} }, "externalId": {string}, "additionalFields" : [ { "id": {string}, "type": {string}, "name": {string}, "values": [ { "id": {string}, "value": {string}, "otherValue": {string} }, { "id": {string}, "name": {string}, "values": [ { "id": {string}, "value": {string}, } ] } ] } ] }
Parameter name Value Description Notes
id string Identifier of the company's staff member.
firstName string First name of the company's staff member. writable
lastName string Last name of the company's staff member. writable
gender string Gender of the company's staff member. Values (male/female) writable
title string Title of the company's staff member. Values (mr/mrs/dr) writable
email string Email address of the company's staff member. writable
phone string Mobile Phone number of the company's staff member. writable
otherPhone string Other phone number of the company's staff member. writable
color string Staff member color, for dashboard displaying. Hexadecimal web color. Default Color: #EFEFEF. writable
description string Description of the company's staff member. writable
picture object Staff picture url and mime type. writable
picture.url string Url of the staff picture.
picture.mimeType string Mime type of the staff picture file. writable
workingHours list Working hours of the company's staff member.
services list Service list of the company's staff member. writable
vacations list Vacation dates of the company's staff member. writable
vacations[].startDate string Start date of the vacation period, in the format "yyyy/mm/dd" writable
vacations[].endDate string End date of the vacation period, in the format "yyyy/mm/dd" writable
availableForWidget boolean Sets if the staff is available for online scheduling. Default value: true writable
role string Role of th staff rattached to his user account. Values: administrator, scheduler, reader. writable
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). writable
end.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company. writable
externalId string Unique staff identifier from another (external) system.
additionalFields list List of additional staff field. writable
additionalFields[].id string Identifier of the additional staff field. writable
additionalFields[].type string Type of the additional staff field (input, checkbox, radio, select , ...). writable
additionalFields[].values list List of values for the additional staff field. Required for type checkbox, radio and select. writable
additionalFields[].values[].id string Identifier of the additional staff field value or staff field category name. Required for type checkbox, radio and select.
additionalFields[].values[].value string Value of the additional staff field value. Required for type checkbox, radio and select with option 'Group by category' set to False or with option 'Custom Value' set to True. writable
additionalFields[].values[].name string Name of the staff field category name. Required for typ select with option 'Group by category' set to True.
additionalFields[].values[].otherValue string Other value of the additional staff field value. Default : "". Set when staff enter custom value on the additional field (option not available on all field type) (OPTIONAL) writable
additionalFields[].values[].values list Available only with input type 'select' and with 'Group by category' set to True. List of values of the addtional staff field. writable
additionalFields[].values[].values[].id string Available only with input type 'select' and with 'Group by category' set to True. Identifier of the additional staff field value
additionalFields[].values[].values[].value string Available only with input type 'select' and with 'Group by category' set to True. Value of the additional staff field. writable

Delete

Deletes an entry on the company's staff member list.

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

Request

HTTP Request

DELETE http://az2.agendize.com/api/2.0/scheduling/companies/{companyId}/staff/{staffId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
staffId string Staff member identifier.

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 staff member list.

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

Request

HTTP Request

GET http://az2.agendize.com/api/2.0/scheduling/companies/{companyId}/staff/{staffId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
staffId string Staff member identifier or external id of staff member.
Optional query parameters
fields string Specify the fields returned. Comma seperated field names (ex: "id,firstName").

Request body

Do not supply a request body with this method.

Response

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


List

Returns entries on the company's staff member list.

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

Request

HTTP Request

GET http://az2.agendize.com/api/2.0/scheduling/companies/{companyId}/staff

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
Optional query parameters
emailAddress datetime Gets staff members who match an email address.
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.

Request body

Do not supply a request body with this method.

Response

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


Insert

Adds an entry to the company's staff member list.

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

Request

HTTP Request

POST http://az2.agendize.com/api/2.0/scheduling/companies/{companyId}/staff

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.

Request body

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

Parameter name Value Description
Required Properties
lastName string Last name of the company's staff member.
Optional Properties
firstName string First name of the company's staff member.
gender string Gender of the company's staff member. Values (male/female)
title string Title of the company's staff member. Values (mr/mrs/dr)
email string Email address of the company's staff member.
phone string Mobile Phone number of the company's staff member.
otherPhone string Other phone number of the company's staff member.
color string Staff member color, for dashboard displaying. Format: xxxxxx. The default value is EFEFEF.
description string Description of the company's staff member.
picture object Staff picture url and mime type.
picture.url string Url of the staff picture.
picture.mimeType string Mime type of the staff picture file.
workingHours list Working hours of the company's staff member. The default values are company's working hours.
services list Service list of the company's staff member. The default list is empty.
availableForWidget boolean Sets if the staff is available for online scheduling. Default value: true
additionalFields list List of additional staff field. The default list is empty.

Response

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


Update

Updates an entry on the company's staff member list.

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

Request

HTTP Request

PUT http://az2.agendize.com/api/2.0/scheduling/companies/{companyId}/staff/{staffId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
staffId string Staff member identifier or external id of staff member.

Request body

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

Parameter name Value Description
Optional Properties
lastName string Last name of the staff member.
firstName string First name of the company's staff member.
gender string Gender of the company's staff member. Values (male/female)
title string Title of the company's staff member. Values (mr/mrs/dr)
email string Email address of the company's staff member.
phone string Mobile Phone number of the company's staff member.
otherPhone string Other phone number of the company's staff member.
color string Staff member color, for dashboard displaying. Format: xxxxxx. The default value is EFEFEF.
description string Description of the company's staff member.
picture object Staff picture url and mime type.
picture.url string Url of the staff picture.
picture.mimeType string Mime type of the staff picture file.
workingHours list Working hours of the company's staff member. The default values are company's working hours.
services list Service list of the company's staff member. The default list is empty.
availableForWidget boolean Sets if the staff is available for online scheduling. Default value: true
additionalFields list List of additional staff field. The default list is empty.

Response

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


Watch

Watch for changes to Staff resources.

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

Request

HTTP Request

POST http://az2.agendize.com/api/2.0/scheduling/companies/{companyId}/staff/watch

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.

Request body

{ "id": {string}, "address": {string} }
Parameter name Value Description
id string Identifier of the watch.
address string The address where notifications are delivered for this watch.

Response

If successful, this method returns an of Watch resource in the response body.