Get all quick messages

GET

/quick-messages

const url = 'https://api.matiasimpulso.com/quick-messages?search=hello&category=general&isActive=true&isVisible=true&isMedia=false&page=1&limit=10&sort=title&dir=asc&userId=1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.matiasimpulso.com/quick-messages?search=hello&category=general&isActive=true&isVisible=true&isMedia=false&page=1&limit=10&sort=title&dir=asc&userId=1' \
  --header 'Authorization: Bearer <token>'

Retrieves all quick messages for the company with optional filtering and pagination

Authorizations

bearer

Parameters

Query Parameters

search

string

Example

hello

Search term to filter by title, shortcode, or message content

category

string

Allowed values: general sales support billing welcome information appointment delivery followup feedback promotional emergency other greeting farewell

Example

welcome

Filter by message category

isActive

boolean

Example

true

Filter by active status

isVisible

boolean

Example

true

Filter by visibility status

isMedia

boolean

Example

false

Filter by media content

page

number

default: 1 >= 1

Example

Page number for pagination

limit

number

default: 10 >= 1 <= 100

Example

Number of items per page

sort

string

default: createdAt

Allowed values: title shortcode createdAt updatedAt category

Example

createdAt

Field to sort by

dir

string

default: desc

Allowed values: asc desc

Example

desc

Sort order

userId

number

Example

Filter by user ID

skip

number

Desplazamiento de la paginación. El frontend lo envía junto a limit; se declara para que el ValidationPipe global no lo rechace.

Responses

200

Quick messages retrieved successfully

application/json

object

data

required

List of quick messages

Array<object>

object

required

Unique identifier

number

shortcode

required

Unique shortcode

string

title

required

Display title

string

message

Message content

string

category

required

Message category

string

isVisible

required

Visibility status

boolean

isActive

required

Active status

boolean

isMedia

required

Has media content

boolean

mediaPath

Media file path

string

mediaName

Original media file name

string

userId

Creator user ID

number

companyId

Company ID

number

createdAt

required

Creation timestamp

string format: date-time

updatedAt

required

Last update timestamp

string format: date-time

user

Creator user information

object

number

name

string

email

string

pagination

required

Pagination information

object

page

Current page

number

limit

Items per page

number

total

Total items

number

pages

Total pages

number

Example

{
  "data": [
    {
      "id": 1,
      "shortcode": "hello",
      "title": "Saludo inicial",
      "message": "Hola, ¿en qué puedo ayudarte?",
      "category": "greeting",
      "isVisible": true,
      "isActive": true,
      "isMedia": false,
      "mediaPath": "/uploads/quick-messages/image.jpg",
      "mediaName": "welcome-image.jpg",
      "userId": 1,
      "companyId": 1,
      "createdAt": "2025-10-04T06:07:41.000Z",
      "updatedAt": "2025-10-04T06:07:41.000Z",
      "user": {
        "id": 1,
        "name": "John Doe",
        "email": "john@example.com"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 10,
    "total": 25,
    "pages": 3
  }
}