Suggestion

Manage suggestions, which represent recommendations or hints for users or the system.
You can search for suggestions with advanced filtering and pagination.

Version

2.0.0

OpenAPI version

3.0.0

Operations

index

POST

/v2/suggestion/index

Returns a paginated and filterable list of suggestions.
Use POST to allow complex filters via JSON payload.

Request Body

Parameters for searching suggestions

object

filter

object

suggestion_id

The unique identifier for the suggestion.

string

type

The type of the suggestion.

string

data

Additional data related to the suggestion, in JSON format.

string format: json

per-page

integer

default: 100 >= 1

page

integer

default: 1 >= 1

sort

The field of the model to sort the list for, use a minus to revert the sort. Es -name is to require the sort in reverse order

string

history

The field establishes whether to also include historized elements that are no longer active in the results. If you leave this parameter empty the response returns only actual entries.

boolean

Example

{
  "filter": {
    "type": "improvement"
  },
  "per-page": 10,
  "page": 1,
  "sort": "type"
}

Responses

200

List of suggestions

Array<object>

object

suggestion_id

The unique identifier for the suggestion.

string

type

The type of the suggestion.

string

data

Additional data related to the suggestion, in JSON format.

string format: json

Example

{
  "suggestion_id": "sug-1",
  "type": "improvement",
  "data": "{\"message\":\"Add a new feature\"}"
}

Headers

X-Pagination-Current-Page

integer

Current page

X-Pagination-Page-Count

integer

Total number of pages

X-Pagination-Per-Page

integer

Number of items per page

X-Pagination-Total-Count

integer

Total number of items

view

GET

/v2/suggestion/view/{id}

Retrieve a suggestion by its unique ID.

Path Parameters

id

required

string format: uuid

ID of the suggestion to retrieve

Responses

200

Suggestion found

object

suggestion_id

The unique identifier for the suggestion.

string

type

The type of the suggestion.

string

data

Additional data related to the suggestion, in JSON format.

string format: json

Example

{
  "suggestion_id": "sug-1",
  "type": "improvement",
  "data": "{\"message\":\"Add a new feature\"}"
}

404

Suggestion not found