Listing User Groups

Returns

Returns a list of User Group objects.

user_groups = galtea.user_groups.list(
    sort_by_created_at="desc",
    limit=10,
)

organization_id

string

Filter user groups by organization ID.

from_created_at

str | int

default:"None"

Filter groups created at or after this timestamp. Accepts ISO 8601 string (e.g., '2024-01-01T00:00:00Z') or Unix timestamp in seconds.

to_created_at

str | int

default:"None"

Filter groups created at or before this timestamp. Accepts ISO 8601 string (e.g., '2024-12-31T23:59:59Z') or Unix timestamp in seconds.

sort_by_created_at

string

Sort groups by creation date. Valid values are "asc" and "desc".

offset

int

default:"0"

Number of groups to skip before starting to collect results. Use for pagination.

limit

int

default:"1000"

Maximum number of groups to return in a single request.