groups_list {civis}

List Groups

Description

List Groups

Usage

groups_list(
  query = NULL,
  permission = NULL,
  include_members = NULL,
  organization_id = NULL,
  user_ids = NULL,
  limit = NULL,
  page_num = NULL,
  order = NULL,
  order_dir = NULL
)

Arguments

query

string optional. If specified, it will filter the groups returned.

permission

string optional. A permissions string, one of "read", "write", or "manage". Lists only groups for which the current user has that permission.

include_members

boolean optional. Show members of the group.

organization_id

integer optional. The organization by which to filter groups.

user_ids

array optional. A list of user IDs to filter groups by.Groups will be returned if any of the users is a member

limit

integer optional. Number of results to return. Defaults to 50. Maximum allowed is 1000.

page_num

integer optional. Page number of the results to return. Defaults to the first page, 1.

order

string optional. The field on which to order the result set. Defaults to name. Must be one of: name, created_at.

order_dir

string optional. Direction in which to sort, either asc (ascending) or desc (descending) defaulting to asc.

Value

An array containing the following fields:

id

integer, The ID of this group.

name

string, This group's name.

createdAt

string, The date and time when this group was created.

updatedAt

string, The date and time when this group was last updated.

description

string, The description of the group.

slug

string, The slug for this group.

organizationId

integer, The ID of the organization this group belongs to.

organizationName

string, The name of the organization this group belongs to.

memberCount

integer, The number of active members in this group.

totalMemberCount

integer, The total number of members in this group.

lastUpdatedById

integer, The ID of the user who last updated this group.

createdById

integer, The ID of the user who created this group.

members

array, An array containing the following fields:

• id integer, The ID of this user.

• name string, This user's name.

• username string, This user's username.

• initials string, This user's initials.

• online boolean, Whether this user is online.