Skip to content
Capturit Backend Docs

Retrieve Messages

GET api/message/list

This is used to retrieve the messages.

Example Request

Terminal window
curl -X 'GET' \
  'http://localhost:8080/api/message/list?group_chat_id=<group_chat_id>&page=<page>&page_length=<page_length>' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer YOUR_TOKEN'

Parameters

group_chat_id

Type: Query
Data Type: Integer
Required: Yes
Description: The ID of the group chat

page

Type: Query
Data Type: Integer
Required: Yes
Description: The current page number in the pagination

page_length

Type: Query
Data Type: Integer
Required: Yes
Description: The number of items displayed per page in the pagination

message_id

Type: Query
Data Type: Integer
Required: No
Description: The ID of the message

Responses

200 - OK

The request was successful

Content Type: application/json
Content: Full Messages

{
  "current_page": 0,
  "data": [
    {
        "id": "string",
        "group_chat_id": "string",
        "message_content": "string",
        "user": {
            "id": 0,
            "user_first_name": "string",
            "user_middle_name": "string",
            "user_last_name": "string",
            "user_username": "string",
            "user_avatar_url": "string",
            "user_visible": "string"
        },
        "replied_to": {
            "id": "string",
            "group_chat_id": "string",
            "message_content": "string",
            "user": {
                "id": 0,
                "user_first_name": "string",
                "user_middle_name": "string",
                "user_last_name": "string",
                "user_username": "string",
                "user_avatar_url": "string",
                "user_visible": "string"
            },
            "created_at": "2025-01-21T05:33:55.062Z",
            "updated_at": "2025-01-21T05:33:55.062Z"
        },
        "seens": [
            {
            "user": {
                "id": 0,
                "user_first_name": "string",
                "user_middle_name": "string",
                "user_last_name": "string",
                "user_avatar_url": "string"
            }
            }
        ],
        "reactions": [
            {
            "id": "string",
            "message_id": "string",
            "message_reaction": "string",
            "message_reaction_count": "string",
            "created_at": "2025-01-21T05:33:55.062Z",
            "updated_at": "2025-01-21T05:33:55.062Z"
            }
        ],
        "attachments": [
            {
            "id": 0,
            "message_attachment_url": "string",
            "message_attachment_added_to_album": true,
            "user": {
                "id": 0,
                "user_first_name": "string",
                "user_middle_name": "string",
                "user_last_name": "string",
                "user_username": "string",
                "user_avatar_url": "string",
                "user_visible": "string"
            },
            "created_at": "2025-01-21T05:33:55.062Z",
            "updated_at": "2025-01-21T05:33:55.062Z"
            }
        ],
        "created_at": "2025-01-21T05:33:55.062Z",
        "updated_at": "2025-01-21T05:33:55.062Z"
    }
  ],
  "first_page_url": "string",
  "from": 0,
  "next_page_url": "string",
  "path": "string",
  "per_page": "string",
  "prev_page_url": "string",
  "to": 0
}

400 - Bad Request

Validation Error

Content Type: application/json
Content:

{
  "param_name": [
    "string"
  ],
  "param_name_2": [
    "string"
  ]
}

401 - Unauthorized

The request requires valid bearer token, but none were provided, or the bearer token is invalid.

429 - Too Many Requests

The user has exceeded the rate limit of 240 requests per minute.

500 - Internal Server Error

There is an issue with the backend. Sentry will provide a more detailed report on the problem.