Agendize Developers API

Home > Agendize Scheduling

Service Groups

Resource representation

{ "id": {string}, "name": {string}, "color": {string}, "picture": { "url": {string}, "mimeType": {string} }, "members": [ { "id": {string}, "name": {string} } ], "parent": { "id": {string}, "name": {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. writable
color string Group color, for dashboard displaying. Hexadecimal web color. Default Color: #EFEFEF. writable
picture object Group picture url and mime type. writable
members list Service list of the group. writable
members[].name string Name of the service.
members[].id string Identifier of the service. Max length 16.
parent object Parent's group. Only if the group has a parent. writable
parent.id string Identifier of the parent's group. writable
parent.name string Name of the parent's group.
externalId string Unique service 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}/serviceGroups/{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}/serviceGroups/{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}/serviceGroups

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}/serviceGroups

Parameters

Parameter name Value Description
Path parameters
companyId string Company identifier.

Request body

In the request body, supply a Group 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.
picture object Group picture .
picture.data string Data URI of the group picture (eg: image/png;base64, xxxxx). See Data URI scheme. Max size: 1MB. If the size is exceeded the picture is ignored.
members list Service list of the group.
members[].id string Identifier of the service.
parent object Parent's group. Only if the group has a parent. writable
parent.id string Identifier of the parent's group. writable
parent.name string Name of the parent's group.
externalId string Unique service identifier from another (external) system.

Response

If successful, this method returns a Staff member 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}/serviceGroups/{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.

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}/serviceGroups/{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.
picture object Group picture .
picture.data string Data URI of the group picture (eg: image/png;base64, xxxxx). See Data URI scheme. Max size: 1MB. If the size is exceeded the picture is ignored.
parent object Parent's group. Only if the group has a parent. writable
parent.id string Identifier of the parent's group. writable
parent.name string Name of the parent's group.
externalId string Unique service identifier from another (external) system.

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.