Skip to main content

Get Group by Unique Name

GET$BEEDEEZ_API/v1/groups/name/{uniqueName}

Get Group by Unique Name

Get Group by unique name.

Path Parameters
uniqueName string — REQUIRED
Responses
200

Ok

Schema — OPTIONAL
type string — OPTIONAL
disabled boolean — OPTIONAL
nbActiveUser double — OPTIONAL
nbUser double — OPTIONAL
description string — OPTIONAL
uniqueName string — OPTIONAL
title string
id string
400

Invalid unique name

Schema — OPTIONAL
statusCode double
kind string
message string
404

Group not found

Schema — OPTIONAL
statusCode double
kind string
message string

Authorization

AuthorizationBearer access tokenadmin scopeHow to get one

Path parameters

uniqueNamestringrequired

Response

200 OKobject
typestring
disabledboolean
nbActiveUserdouble
nbUserdouble
descriptionstring
uniqueNamestring
titlestring
idstring

Errors

400Invalid unique name
404Group not found
Stuck on an integration?
Write to the developer team with your request ID and we'll get back to you quickly.