Returns all groups available for a given member

  • 1 minute(s) read
Prev Next
Get
/group_members_available

Display a listing of groups available

Security
OAuth

Laravel passport oauth2 security.

FlowAuthorization Code
Authorization URLhttp://processmaker.test/oauth/authorize
Token URLhttp://processmaker.test/oauth/token
Refresh URLhttp://processmaker.test/token/refresh
HTTP
Type bearer
Path parameters
member_id
stringRequired

ID of group member to return

member_type
stringRequired

type of group member to return

Query parameters
filter
string

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

order_by
string

Field to order results by

order_direction
string
Valid values[ "asc", "desc" ]
Default"asc"
per_page
integer
Default10
Responses
200

list of groups available to be assigned as member

Expand All
object
data
Array of object (availableGroupMembers)
object
id
string (id)
description
string
name
string
status
string
Valid values[ "ACTIVE", "INACTIVE" ]
created_at
string (date-time)
updated_at
string (date-time)
meta
object (metadata)
filter
string
sort_by
string
sort_order
string
Valid values[ "asc", "desc" ]
count
integer
total_pages
integer
current_page
integer
form
integer
last_page
integer
path
string
per_page
integer
to
integer
total
integer