Groups

Get Group

Returns a group object based on a group name.

Authorization Required:

Designer Administrator

get/groups/{groupName}

Request

Base URL
https://env.unqork.io/api/1.0
Auth
OAuth 2
Client credentials
Password
Token URLhttps://xyzfinancial.unqork.io/api/1.0/oauth2/access_token
TypeScript
https://skmtc.dev/unqork/apis/unqork-customer-api/docs/groups/:groupName/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

groupNamestring required

Name of group to retrieve

Response

Group

namestring

descriptionstring

type'role_descendents' | 'own_role_and_descendents' | 'ignore_role'

See Group Administration screen for definitions

Changes

No recorded changes to this operation across all 6 revisions of this API.