Get a Lumeo AccountDocs
API Reference
Login to Lumeo Console

List User Groups

get
https://api.lumeo.com/v1/apps//user_groups

Lists user groups in this application. Each application has an
auto-managed default group ("All members") with is_default = true,
plus any explicitly created groups. Use group ids in
notification_rules.user_group_ids to address recipients.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The application these user groups belong to.

Query Params
user_group_ids[]
array of uuids

Filter: User group ID(s)

user_group_ids[]
names[]
array of strings

Filter: User group name(s)

names[]
enum
required

Specifies which type of pagination to choose.

Allowed:
string

Specifies the cursor for the next page. Can be found in the last paginated request. Only available with pagination = cursor.

string

Specifies the cursor for the previous page. Can be found in the last paginated request. Only available with pagination = cursor.

integer
≥ 1

Specifies which page should be returned. Only available with pagination = offset.

integer

Limits the number of items returned.

Response

Updated 20 days ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 20 days ago