Returns all collections that the user has access to

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

Get a list of Collections.

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
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 collections

Expand All
object
data
Array of object (collections)
object
name
string
description
string
custom_title
string
create_screen_id
string (id)
read_screen_id
string (id)
update_screen_id
string (id)
signal_create
boolean
signal_update
boolean
signal_delete
boolean
id
integer
created_at
string (date-time)
updated_at
string (date-time)
created_by_id
string (id)
updated_by_id
string (id)
columns
Array of object
object
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