Returns all users

Prev Next
Get
/saved-searches/{savedSearchId}/users

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
Path parameters
savedSearchId
stringRequired

ID of saved search to return

Query parameters
filter
string

Filter results by string. Searches First Name, Last Name, Email and Username.

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 users

Expand All
object
data
Array of object (users)
object
email
string (email)

The attributes that are mass assignable.

firstname
string
lastname
string
username
string
password
string
address
string
city
string
state
string
postal
string
country
string
phone
string
fax
string
cell
string
title
string
timezone
string
datetime_format
string
language
string
is_administrator
boolean
expires_at
string
loggedin_at
string
remember_token
string
status
string
Valid values[ "ACTIVE", "INACTIVE", "SCHEDULED", "OUT_OF_OFFICE", "BLOCKED" ]
fullname
string
avatar
string
media
Array of object (media)
object
id
integer (id)

Represents media files stored in the database

model_id
integer (id)
model_type
string (id)
collection_name
string
name
string
file_name
string
mime_type
string
disk
string
size
integer
manipulations
object
custom_properties
object
responsive_images
object
order_column
integer
created_at
string (date-time)
updated_at
string (date-time)
birthdate
string (date)
delegation_user_id
string (id)
manager_id
string (id)
meta
object
force_change_password
boolean
id
integer
created_at
string (date-time)
updated_at
string (date-time)
deleted_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