Returns all groups that the user has access to

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

Display a listing of the resource.

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
Query parameters
status
string

ACTIVE or INACTIVE

Valid values[ "ACTIVE", "INACTIVE" ]
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
include
string

Include data from related models in payload. Comma separated list.

Default""
Responses
200

list of groups

Expand All
object
data
Array of object (groups)
object
name
string

Represents a group definition.

description
string
manager_id
integer (id)
status
string
Valid values[ "ACTIVE", "INACTIVE" ]
created_at
string (date-time)
updated_at
string (date-time)
id
string (id)
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