Get
/collections/{collection_id}/records
Get the list of records of a collection.
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
collection_id
stringRequired
ID of collection to get records for
Query parameters
pmql
string
per_page
integer
Default10
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"
include
string
Include data from related models in payload. Comma separated list.
Default""
Responses
200
list of records of a collection
object
data
Array of object (records)
object
data
object
id
integer
collection_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