v1

latestOpenAPI 3.0.02026-07-263403911.5 MB
UserGroups

Search user groups

Search for one or more user groups.

get/v1/UserGroups

Query parameters

search.user_group_idinteger[]

Query by user group identifier.

search.group_type'TASK' | 'TICKET' | 'PREORDER' | 'ORDER' | 'NOTIFICATION' | 'REQUEST'

Query by kind of group.

search.namestring[]

Query by all or part of name.

search.activeboolean

Return when Null: All; when True: Only Active; when False: Only Inactive.

search.page_sizeinteger

Defines how many items to return at a time.

search.pageinteger

Specifies which page to display (i.e. 3rd page of 50 items out of 1000 items)

search.sortstring

Specifies the model member you wish to sort by. Defaults to Ascending order, add a "-" sign to the beginning to indicate Descending order.

Response

OK

okboolean
has_moreboolean

Helper for pagination. Indicates there are more records returned.

record_countinteger

Total number of records found by the search.