Jump to content

REST API Documentation

/core/groups


Get list of groups

Parameters

Name Type Description
page int Page number
perPage int Number of results per page - defaults to 25

Exceptions

This endpoint doesn't throw any exceptions.

Response

Name Type Description
page int The page number for the results being shown
perPage int The number of results that will be on each page
totalResults int The total number of results
totalPages int The number of pages of results
results array of group objects The results for this page

group object

Name Type Description
id int ID number
name string Name
formattedName string Name with formatting
×
×
  • Create New...