HomeGuidesAPI Reference
API Reference

List All User Groups

get
https://v2.api.uberflip.com/user-groups

This endpoint returns a paginated list of all User Groups in an Uberflip account, as well as metadata for the response.

Query Params
string

Filter results by User Group name.

string

Specify the field that should be used to sort the returned User Groups. See the table below for accepted sort values. Sort order will be either ascending or alphabetical depending on the field specified.

  • id: Sort by User Group identifier code
  • name: Sort by User Group name
  • user_count: Sort by number of users in each User Group
  • created_at: Sort by User Group creation date
  • modified_at: Sort by date on which User Group was last modified
integer
1 to 100
Defaults to 25

Set the number of results returned per page. Defaults to 25 if not set.

integer
≥ 1
Defaults to 1

Specify the page of results to be returned. Defaults to 1 if not set.

Response

Updated over 3 years ago

Language
Credentials
Bearer
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated over 3 years ago 



































    

        
x