processmaker.comKnowledge CenterProcessMaker University

Saved Search

Returns all saved search charts that the user has access to

get

Get a list of SavedSearchCharts.

Authorizations
Query parameters
filterstringOptional

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

typestring · enumOptional

Only return saved searches by type

Possible values:
order_bystringOptional

Field to order results by

order_directionstring · enumOptionalDefault: ascPossible values:
per_pageintegerOptionalDefault: 10
includestringOptional

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

Default: ""
Responses
200
list of saved search charts
application/json
get
GET /api/1.0/saved-searches/{saved_search_id}/charts HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

list of saved search charts

{
  "data": [
    {
      "id": "text",
      "saved_search_id": "text",
      "user_id": "text",
      "created_at": "2025-07-12T04:20:06.775Z",
      "updated_at": "2025-07-12T04:20:06.775Z",
      "deleted_at": "2025-07-12T04:20:06.775Z",
      "title": "text",
      "type": "bar",
      "config": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "sort": 1
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Save a new saved search chart

post

Create a new SavedSearchChart.

Authorizations
Path parameters
saved_search_idstringRequired

ID of saved search to which this chart will be saved

Body
titlestringOptional

Represents an Eloquent model of a Saved Search Chart.

typestring · enumOptionalPossible values:
sortintegerOptional
Responses
201
success
application/json
Responseall of
post
POST /api/1.0/saved-searches/{saved_search_id}/charts HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "title": "text",
  "type": "bar",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "sort": 1
}
201

success

{
  "id": "text",
  "saved_search_id": "text",
  "user_id": "text",
  "created_at": "2025-07-12T04:20:06.775Z",
  "updated_at": "2025-07-12T04:20:06.775Z",
  "deleted_at": "2025-07-12T04:20:06.775Z",
  "title": "text",
  "type": "bar",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "sort": 1
}

Update several saved search charts at once

put

Batch update several SavedSearchCharts.

Authorizations
Path parameters
saved_search_idstringRequired

ID of saved search to which these charts will be saved

Bodyall of[]
itemsall ofOptional
Responses
204
success
put
PUT /api/1.0/saved-searches/{saved_search_id}/charts HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 256

[
  {
    "id": "text",
    "saved_search_id": "text",
    "user_id": "text",
    "created_at": "2025-07-12T04:20:06.775Z",
    "updated_at": "2025-07-12T04:20:06.775Z",
    "deleted_at": "2025-07-12T04:20:06.775Z",
    "title": "text",
    "type": "bar",
    "config": {
      "ANY_ADDITIONAL_PROPERTY": null
    },
    "sort": 1
  }
]
204

success

No content

Get single saved search chart by ID

get

Get a single SavedSearchChart.

Authorizations
Path parameters
chart_idstringRequired

ID of chart to return

Responses
200
Successfully found the saved search chart
application/json
Responseall of
get
GET /api/1.0/saved-searches/charts/{chart_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Successfully found the saved search chart

{
  "id": "text",
  "saved_search_id": "text",
  "user_id": "text",
  "created_at": "2025-07-12T04:20:06.775Z",
  "updated_at": "2025-07-12T04:20:06.775Z",
  "deleted_at": "2025-07-12T04:20:06.775Z",
  "title": "text",
  "type": "bar",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "sort": 1
}

Update a saved search chart

put

Update a SavedSearchChart.

Authorizations
Path parameters
chart_idstringRequired

ID of chart to return

Body
titlestringOptional

Represents an Eloquent model of a Saved Search Chart.

typestring · enumOptionalPossible values:
sortintegerOptional
Responses
200
success
application/json
Responseall of
put
PUT /api/1.0/saved-searches/charts/{chart_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 80

{
  "title": "text",
  "type": "bar",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "sort": 1
}
200

success

{
  "id": "text",
  "saved_search_id": "text",
  "user_id": "text",
  "created_at": "2025-07-12T04:20:06.775Z",
  "updated_at": "2025-07-12T04:20:06.775Z",
  "deleted_at": "2025-07-12T04:20:06.775Z",
  "title": "text",
  "type": "bar",
  "config": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "sort": 1
}

Delete a saved search chart

delete

Delete a SavedSearchChart.

Authorizations
Path parameters
chart_idstringRequired

ID of chart to return

Responses
204
success
delete
DELETE /api/1.0/saved-searches/charts/{chart_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
204

success

No content

Get available chart fields for a Saved Search by ID

get

Get available chart fields for a Saved Search.

Authorizations
Path parameters
chart_idstringRequired

ID of Saved Search to return

Responses
200
Successfully found the saved search
application/json
Responseall of
get
GET /api/1.0/saved-searches/charts/{chart_id}/fields HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Successfully found the saved search

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-07-12T04:20:06.775Z",
  "updated_at": "2025-07-12T04:20:06.775Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

Save a new report

post
Authorizations
Body
typestring · enumOptionalPossible values:
formatstring · enumOptionalPossible values:
saved_search_idintegerOptional
tostring[]Optional
subjectstringOptional
bodystringOptional
Responses
201
success
application/json
Responseall of
post
POST /api/1.0/saved-searches/reports HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "type": "adhoc",
  "format": "csv",
  "saved_search_id": 1,
  "config": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "to": [
    "text"
  ],
  "subject": "text",
  "body": "text"
}
201

success

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-07-12T04:20:06.775Z",
  "updated_at": "2025-07-12T04:20:06.775Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

Update a saved search

put

Update a Report

Authorizations
Path parameters
reportIdstringRequired

ID of report

Body
pmqlstringOptional
titlestringOptional
typestring · enumOptionalPossible values:
Responses
200
success
application/json
Responseall of
put
PUT /api/1.0/saved-searches/reports/{reportId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}
200

success

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-07-12T04:20:06.775Z",
  "updated_at": "2025-07-12T04:20:06.775Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

Returns all saved searches that the user has access to

get

Get a list of SavedSearches.

Authorizations
Query parameters
filterstringOptional

Filter results by string. Searches Name, Description, and Status. Status must match exactly. Others can be a substring.

typestring · enumOptional

Only return saved searches by type

Possible values:
subsetstring · enumOptional

Only return saved searches that are yours or those that have been shared with you

Possible values:
order_bystringOptional

Field to order results by

order_directionstring · enumOptionalDefault: ascPossible values:
per_pageintegerOptionalDefault: 10
includestringOptional

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

Default: ""
Responses
200
list of saved searches
application/json
get
GET /api/1.0/saved-searches HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

list of saved searches

{
  "data": [
    {
      "id": "text",
      "user_id": "text",
      "created_at": "2025-07-12T04:20:06.775Z",
      "updated_at": "2025-07-12T04:20:06.775Z",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": null
      },
      "pmql": "text",
      "title": "text",
      "type": "task"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Save a new saved search

post

Create a new SavedSearch.

Authorizations
Body
pmqlstringOptional
titlestringOptional
typestring · enumOptionalPossible values:
Responses
201
success
application/json
Responseall of
post
POST /api/1.0/saved-searches HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}
201

success

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-07-12T04:20:06.775Z",
  "updated_at": "2025-07-12T04:20:06.775Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

Get single saved searches by ID

get

Get a single SavedSearch.

Authorizations
Path parameters
savedSearchIdstringRequired

ID of saved search to return

Responses
200
Successfully found the saved search
application/json
Responseall of
get
GET /api/1.0/saved-searches/{savedSearchId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Successfully found the saved search

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-07-12T04:20:06.775Z",
  "updated_at": "2025-07-12T04:20:06.775Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

Update a saved search

put

Update a SavedSearch.

Authorizations
Path parameters
savedSearchIdstringRequired

ID of saved search to return

Body
pmqlstringOptional
titlestringOptional
typestring · enumOptionalPossible values:
Responses
200
success
application/json
Responseall of
put
PUT /api/1.0/saved-searches/{savedSearchId} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 84

{
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}
200

success

{
  "id": "text",
  "user_id": "text",
  "created_at": "2025-07-12T04:20:06.775Z",
  "updated_at": "2025-07-12T04:20:06.775Z",
  "meta": {
    "ANY_ADDITIONAL_PROPERTY": null
  },
  "pmql": "text",
  "title": "text",
  "type": "task"
}

Returns all columns associated with a Saved Search

get

Display a listing of columns.

Authorizations
Path parameters
savedSearchIdstringRequired

ID of saved search to return

Query parameters
Responses
200
Categorized list of columns
application/json
get
GET /api/1.0/saved-searches/{savedSearchId}/columns HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

Categorized list of columns

{
  "current": [
    {
      "label": "text",
      "field": "text",
      "sortable": true,
      "default": true,
      "format": "text",
      "mask": "text"
    }
  ],
  "default": [
    {
      "label": "text",
      "field": "text",
      "sortable": true,
      "default": true,
      "format": "text",
      "mask": "text"
    }
  ],
  "available": [
    {
      "label": "text",
      "field": "text",
      "sortable": true,
      "default": true,
      "format": "text",
      "mask": "text"
    }
  ],
  "data": [
    {
      "label": "text",
      "field": "text",
      "sortable": true,
      "default": true,
      "format": "text",
      "mask": "text"
    }
  ]
}

Returns all users

get

Display a listing of the resource.

Authorizations
Path parameters
savedSearchIdstringRequired

ID of saved search to return

Query parameters
filterstringOptional

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

order_bystringOptional

Field to order results by

order_directionstring · enumOptionalDefault: ascPossible values:
per_pageintegerOptionalDefault: 10
includestringOptional

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

Default: ""
Responses
200
list of users
application/json
get
GET /api/1.0/saved-searches/{savedSearchId}/users HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

list of users

{
  "data": [
    {
      "email": "name@gmail.com",
      "firstname": "text",
      "lastname": "text",
      "username": "text",
      "password": "text",
      "address": "text",
      "city": "text",
      "state": "text",
      "postal": "text",
      "country": "text",
      "phone": "text",
      "fax": "text",
      "cell": "text",
      "title": "text",
      "timezone": "text",
      "datetime_format": "text",
      "language": "text",
      "is_administrator": true,
      "expires_at": "text",
      "loggedin_at": "text",
      "remember_token": "text",
      "status": "ACTIVE",
      "fullname": "text",
      "avatar": "text",
      "media": [
        {
          "id": 1,
          "model_id": 1,
          "model_type": "text",
          "collection_name": "text",
          "name": "text",
          "file_name": "text",
          "mime_type": "text",
          "disk": "text",
          "size": 1,
          "manipulations": {},
          "custom_properties": {},
          "responsive_images": {},
          "order_column": 1,
          "created_at": "2025-07-12T04:20:06.775Z",
          "updated_at": "2025-07-12T04:20:06.775Z"
        }
      ],
      "birthdate": "2025-07-12",
      "delegation_user_id": "text",
      "manager_id": "text",
      "meta": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "force_change_password": true,
      "id": 1,
      "created_at": "2025-07-12T04:20:06.775Z",
      "updated_at": "2025-07-12T04:20:06.775Z",
      "deleted_at": "2025-07-12T04:20:06.775Z"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Returns all groups that the user has access to

get

Display a listing of the resource.

Authorizations
Query parameters
order_bystringOptional

Field to order results by

order_directionstring · enumOptionalDefault: ascPossible values:
per_pageintegerOptionalDefault: 10
includestringOptional

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

Default: ""
Responses
200
list of groups
application/json
get
GET /api/1.0/saved-searches/{savedSearchId}/groups HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

list of groups

{
  "data": [
    {
      "name": "text",
      "description": "text",
      "manager_id": 1,
      "status": "ACTIVE",
      "created_at": "2025-07-12T04:20:06.775Z",
      "updated_at": "2025-07-12T04:20:06.775Z",
      "id": "text"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}

Delete a saved search

delete

Delete a SavedSearch.

Authorizations
Path parameters
saved_search_idstringRequired

ID of saved search to return

Responses
204
success
delete
DELETE /api/1.0/saved-searches/{saved_search_id} HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
204

success

No content

Returns all icons for saved searches

get

Get a list of icons available for SavedSearches.

Authorizations
Query parameters
per_pageintegerOptionalDefault: 10
Responses
200
list of icons for saved searches
application/json
get
GET /api/1.0/saved-searches/icons HTTP/1.1
Host: 
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*
200

list of icons for saved searches

{
  "data": [
    {
      "name": "text",
      "value": "text"
    }
  ],
  "meta": {
    "filter": "text",
    "sort_by": "text",
    "sort_order": "asc",
    "count": 1,
    "total_pages": 1,
    "current_page": 1,
    "form": 1,
    "last_page": 1,
    "path": "text",
    "per_page": 1,
    "to": 1,
    "total": 1
  }
}
PreviousDecision EngineNextVersions

Last updated