Agendize Developers API

Home > Agendize Scheduling

Staff Groups

Resource representation

{ "id": {string}, "name": {string}, "color": {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} } ] } ], "members": [ { "id": {string}, "firstName": {string}, "lastName": {string}, "selfLink": {string} } ], "managers": [ { "id": {string}, "firstName": {string}, "lastName": {string}, "email": {string} } ], "customWorkingHours": [ { "name":{string}, "startPeriod": { "dateTime": {string}, "timeZone": {string} }, "endPeriod": { "dateTime": {string}, "timeZone": {string} }, "sunday": [ { "service": { "name": {string}, "id": {string} }, "start": {string}, "end": {string} } ], "monday": [ { "service": { "name": {string}, "id": {string} }, "start": {string}, "end": {string} } ], "tuesday": [ { "service": { "name": {string}, "id": {string} }, "start": {string}, "end": {string} } ], "wednesday": [ { "service": { "name": {string}, "id": {string} }, "start": {string}, "end": {string} } ], "thursday": [ { "service": { "name": {string}, "id": {string} }, "start": {string}, "end": {string} } ], "friday": [ { "service": { "name": {string}, "id": {string} }, "start": {string}, "end": {string} } ], "saturday": [ { "service": { "name": {string}, "id": {string} }, "start": {string}, "end": {string} } ] } ], "externalId" : {string}, "extendedProperties": { "private": {object}, "public": {object} } }
Parameter name Value Description
id string Identifier of the group.
name string Name of the group. Max length 127.
color string Group color, for dashboard displaying. Hexadecimal web color. Default Color: #EFEFEF.
workingHours list Working hours of the group.
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[].satruday list List of working hours for satruday. Only if hours are defined for the day. writable
workingHours[].satruday[].start string Start hour. Format: HH:mm. writable
workingHours[].satruday[].end string End hour. Format: HH:mm. writable
members list Staff list of the group.
members[].firstName string First name of the staff member
members[].lastName string Last name of the staff member
members[].id string Identifier of the staff member
members[].selfLink string API link of the staff member
managers list Manager lists of the group.
managers[].firstName string First name of the manager
managers[].lastName string Last name of the manager
managers[].id string User id of the manager
managers[].email string Email of the manager
customWorkingHours list Custom Working hours (per period) of the company's staff member.
customWorkingHours[].name object Name of the custom period. writable
customWorkingHours[].startPeriod object Start date of the custom period.
customWorkingHours[].startPeriod.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information).
customWorkingHours[].startPeriod.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company. read-only
customWorkingHours[].endPeriod object Start date of the custom period.
customWorkingHours[].endPeriod.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information).
customWorkingHours[].endPeriod.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company. read-only
customWorkingHours[].sunday list List of custom working hours for sunday. Only if hours are defined for the day.
customWorkingHours[].sunday[].start string Start hour. Format: HH:mm.
customWorkingHours[].sunday[].end string End hour. Format: HH:mm.
customWorkingHours[].sunday[].service object Service concerned by the working hour. Only if a service is defined for the working hour
customWorkingHours[].sunday[].service.id object Id of service.
customWorkingHours[].sunday[].service.name object Name of service.
customWorkingHours[].monday list List of custom working hours for monday. Only if hours are defined for the day.
customWorkingHours[].monday[].start string Start hour. Format: HH:mm.
customWorkingHours[].monday[].end string End hour. Format: HH:mm.
customWorkingHours[].monday[].service object Service concerned by the working hour. Only if a service is defined for the working hour
customWorkingHours[].monday[].service.id object Id of service.
customWorkingHours[].monday[].service.name object Name of service.
customWorkingHours[].tuesday list List of custom working hours for tuesday. Only if hours are defined for the day.
customWorkingHours[].tuesday[].start string Start hour. Format: HH:mm.
customWorkingHours[].tuesday[].end string End hour. Format: HH:mm.
customWorkingHours[].tuesday[].service object Service concerned by the working hour. Only if a service is defined for the working hour
customWorkingHours[].tuesday[].service.id object Id of service.
customWorkingHours[].tuesday[].service.name object Name of service.
customWorkingHours[].wednesday list List of custom working hours for wednesday. Only if hours are defined for the day.
customWorkingHours[].wednesday[].start string Start hour. Format: HH:mm.
customWorkingHours[].wednesday[].end string End hour. Format: HH:mm.
customWorkingHours[].wednesday[].service object Service concerned by the working hour. Only if a service is defined for the working hour
customWorkingHours[].wednesday[].service.id object Id of service.
customWorkingHours[].wednesday[].service.name object Name of service.
customWorkingHours[].thursday list List of custom working hours for thursday. Only if hours are defined for the day.
customWorkingHours[].thursday[].start string Start hour. Format: HH:mm.
customWorkingHours[].thursday[].end string End hour. Format: HH:mm.
customWorkingHours[].thursday[].service object Service concerned by the working hour. Only if a service is defined for the working hour
customWorkingHours[].thursday[].service.id object Id of service.
customWorkingHours[].thursday[].service.name object Name of service.
customWorkingHours[].friday list List of custom working hours for friday. Only if hours are defined for the day.
customWorkingHours[].friday[].start string Start hour. Format: HH:mm.
customWorkingHours[].friday[].end string End hour. Format: HH:mm.
customWorkingHours[].friday[].service object Service concerned by the working hour. Only if a service is defined for the working hour
customWorkingHours[].friday[].service.id object Id of service.
customWorkingHours[].friday[].service.name object Name of service.
customWorkingHours[].satruday list List of custom working hours for satruday. Only if hours are defined for the day.
customWorkingHours[].satruday[].start string Start hour. Format: HH:mm.
customWorkingHours[].satruday[].end string End hour. Format: HH:mm.
customWorkingHours[].satruday[].service object Service concerned by the working hour. Only if a service is defined for the working hour
customWorkingHours[].satruday[].service.id object Id of service.
customWorkingHours[].satruday[].service.name object Name of service.
externalId string Unique staff group identifier from another (external) system.
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

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}/staffGroups/{groupId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
groupId string Group identifier.

Request body

Do not supply a request body with this method.

Response

If successful, this method returns an empty response body.

Get

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}/staffGroups/{groupId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
groupId string Group identifier.

Request body

Do not supply a request body with this method.

Response

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

List

Returns entries on the company's staff group 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}/staffGroups

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.

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: [Group resource] }

Insert

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/{companyId}/staffGroups

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
name string Name of the group.
Optional Properties
color string Group color, for dashboard displaying. Hexadecimal web color. Default Color: #EFEFEF.
workingHours list Working hours of the group.
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
members list Staff list of the group.
members[].id string Identifier of the staff member

Response

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

Patch

Add values in arrays of properties of an entry on the company's service groups list. Only properties listed bellow are supported

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

Request

HTTP Request

PATCH https://api.agendize.com/api/2.1/scheduling/companies/{companyId}/staffGroups/{groupId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
groupId string Group identifier.

Request body

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

Parameter name Value Description
Optional Properties
color string Group color, for dashboard displaying. Hexadecimal web color. Default Color: #EFEFEF.
members list Service list of the group.
members[].id string Identifier of the service.
customWorkingHours list Custom Working hours (per period) of the company's staff member.
customWorkingHours[].startPeriod object Start date of the custom period. writable
customWorkingHours[].startPeriod.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information). writable
customWorkingHours[].startPeriod.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company. writable
customWorkingHours[].endPeriod object Start date of the custom period. writable
customWorkingHours[].endPeriod.dateTime string The time, as a combined date-time value (formatted according to RFC 3339, without time zone information). writable
customWorkingHours[].endPeriod.timeZone string The time zone. Possible values can be found here. The default value is the time zone of the company. writable
customWorkingHours[].sunday list List of custom working hours for sunday. Only if hours are defined for the day. writable
customWorkingHours[].sunday[].start string Start hour. Format: HH:mm. writable
customWorkingHours[].sunday[].end string End hour. Format: HH:mm. writable
customWorkingHours[].sunday[].service object Service concerned by the working hour. Only if a service is defined for the working hour writable
customWorkingHours[].sunday[].service.id object Id of service. writable
customWorkingHours[].sunday[].service.name object Name of service.
customWorkingHours[].monday list List of custom working hours for monday. Only if hours are defined for the day. writable
customWorkingHours[].monday[].start string Start hour. Format: HH:mm. writable
customWorkingHours[].monday[].end string End hour. Format: HH:mm. writable
customWorkingHours[].monday[].service object Service concerned by the working hour. Only if a service is defined for the working hour writable
customWorkingHours[].monday[].service.id object Id of service. writable
customWorkingHours[].monday[].service.name object Name of service.
customWorkingHours[].tuesday list List of custom working hours for tuesday. Only if hours are defined for the day. writable
customWorkingHours[].tuesday[].start string Start hour. Format: HH:mm. writable
customWorkingHours[].tuesday[].end string End hour. Format: HH:mm. writable
customWorkingHours[].tuesday[].service object Service concerned by the working hour. Only if a service is defined for the working hour writable
customWorkingHours[].tuesday[].service.id object Id of service. writable
customWorkingHours[].tuesday[].service.name object Name of service.
customWorkingHours[].wednesday list List of custom working hours for wednesday. Only if hours are defined for the day. writable
customWorkingHours[].wednesday[].start string Start hour. Format: HH:mm. writable
customWorkingHours[].wednesday[].end string End hour. Format: HH:mm. writable
customWorkingHours[].wednesday[].service object Service concerned by the working hour. Only if a service is defined for the working hour writable
customWorkingHours[].wednesday[].service.id object Id of service. writable
customWorkingHours[].wednesday[].service.name object Name of service.
customWorkingHours[].thursday list List of custom working hours for thursday. Only if hours are defined for the day. writable
customWorkingHours[].thursday[].start string Start hour. Format: HH:mm. writable
customWorkingHours[].thursday[].end string End hour. Format: HH:mm. writable
customWorkingHours[].thursday[].service object Service concerned by the working hour. Only if a service is defined for the working hour writable
customWorkingHours[].thursday[].service.id object Id of service. writable
customWorkingHours[].thursday[].service.name object Name of service.
customWorkingHours[].friday list List of custom working hours for friday. Only if hours are defined for the day. writable
customWorkingHours[].friday[].start string Start hour. Format: HH:mm. writable
customWorkingHours[].friday[].end string End hour. Format: HH:mm. writable
customWorkingHours[].friday[].service object Service concerned by the working hour. Only if a service is defined for the working hour writable
customWorkingHours[].friday[].service.id object Id of service. writable
customWorkingHours[].friday[].service.name object Name of service.
customWorkingHours[].saturday list List of custom working hours for saturday. Only if hours are defined for the day. writable
customWorkingHours[].saturday[].start string Start hour. Format: HH:mm. writable
customWorkingHours[].saturday[].end string End hour. Format: HH:mm. writable
customWorkingHours[].saturday[].service object Service concerned by the working hour. Only if a service is defined for the working hour writable
customWorkingHours[].saturday[].service.id object Id of service. writable
customWorkingHours[].saturday[].service.name object Name of service.

Response

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

Update

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}/staffGroups/{groupId}

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.
groupId string Group identifier.

Request body

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

Parameter name Value Description
Optional Properties
name string Name of the group.
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

Response

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

Agendize | Support | Status

Last update: Oct 15, 2024 - Copyright © 2024 Agendize. All rights reserved.