Relesys API Docs


User Groups

Get User Groups
GET /userGroups
Get all user groups - Can be filtered by the listed properties.
Scopes: relesys.api, relesys.api:read, relesys.api.users, relesys.api.users:read
Query String
creationDateTime datetime Filterable Sortable optional
description string Filterable Sortable optional
externalId string Filterable Sortable optional
id string / guid Filterable optional
lastModifiedDateTime datetime Filterable Sortable optional
name string Filterable Sortable optional
sort string Comma separated sort order based on sortable properties optional
offset integer Offset value for use in pagination Default: 0 optional
limit integer Total objects to fetch (max 1000) Default: 200 optional
{"count":2,"data":[{"id":"0b69d9f2-4fc3-4716-8a2d-9b89985f2bb8","url":null,"creationDateTime":"1991-12-25T13:14:35Z","lastModifiedDateTime":"2018-06-09T04:58:45Z","name":"User Group A","externalId":"UGA","description":"Description for User Group A"},{"id":"8aa06da2-967b-4136-8cfa-7791e7f7eb28","url":null,"creationDateTime":"1991-12-25T13:14:35Z","lastModifiedDateTime":"2018-06-09T04:58:45Z","name":"User Group B","externalId":"UGB","description":"Description for User Group B"}]}
  count integer      
  data array[object]      
   description string      
   externalId string      
   id string / guid      
   name string      
   url string      
  nextUrl string      
  previousUrl string