Returns all screens that the user has access to

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

Get a list of Screens.

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""
exclude
string

Comma separated list of fields to exclude from the response

Default""
Responses
200

list of screens

Expand All
object
data
Array of object (screens)
object
title
string

Class Screen

type
string
description
string
config
Array of object
object
computed
Array of object
object
watchers
Array of object
object
custom_css
string
screen_category_id
string
id
string (id)
created_at
string (date-time)
updated_at
string (date-time)
meta
object