Skip to main content
GET
/
v2
/
access
/
chats
/
:userId
/
messages
Chat messages
curl --request GET \
  --url https://api.ofauth.com/v2/access/chats/:userId/messages \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>'
{
  "list": [
    {
      "id": 123,
      "text": "<string>",
      "fromUser": {
        "id": 123,
        "name": "<string>"
      },
      "media": [
        {
          "id": 123,
          "convertedToVideo": true,
          "canView": true,
          "hasError": true,
          "createdAt": "<string>",
          "isReady": true,
          "releaseForms": [
            {
              "id": 123,
              "name": "<string>",
              "partnerSource": "<string>",
              "type": "<string>",
              "user": {
                "view": "<string>",
                "id": 123,
                "name": "<string>",
                "username": "<string>",
                "isVerified": true,
                "avatar": "<string>",
                "avatarThumbs": {
                  "c50": "<string>",
                  "c144": "<string>"
                },
                "ivStatus": "<string>",
                "isFromGuest": true
              }
            }
          ],
          "duration": 123,
          "hasCustomPreview": true,
          "videoSources": {
            "240": "<string>",
            "720": "<string>"
          },
          "files": {
            "full": {
              "url": "<string>",
              "sources": [
                {
                  "url": "<string>",
                  "width": 123,
                  "height": 123,
                  "type": "<string>"
                }
              ],
              "width": 123,
              "height": 123,
              "size": 123
            },
            "thumb": {
              "url": "<string>",
              "width": 123,
              "height": 123,
              "size": 123
            },
            "preview": {
              "url": "<string>",
              "options": [
                {
                  "url": "<string>",
                  "width": 123,
                  "height": 123,
                  "type": "<string>"
                }
              ],
              "width": 123,
              "height": 123,
              "size": 123
            },
            "squarePreview": {
              "url": "<string>",
              "width": 123,
              "height": 123,
              "size": 123
            }
          }
        }
      ],
      "previews": [
        123
      ],
      "isMediaReady": true,
      "mediaCount": 123,
      "lockedText": true,
      "responseType": "<string>",
      "giphyId": "<string>",
      "isFree": true,
      "isTip": true,
      "isReportedByMe": true,
      "isCouplePeopleMedia": true,
      "queueId": 123,
      "isMarkdownDisabled": true,
      "releaseForms": null,
      "isFromQueue": true,
      "canUnsendQueue": true,
      "unsendSecondsQueue": 123,
      "isOpened": true,
      "isNew": true,
      "createdAt": "<string>",
      "changedAt": "<string>",
      "cancelSeconds": 123,
      "isLiked": true,
      "canPurchase": true,
      "canPurchaseReason": "<string>",
      "canReport": true,
      "canBePinned": true,
      "isPinned": true
    }
  ],
  "hasMore": true,
  "nextLastId": "<string>"
}

Authorizations

​
apiKey
string
header
required

Your OFAuth API key for authenticating requests.

​
x-connection-id
string
header
required

Requires a connection via the x-connection-id header.

Path Parameters

​
userId
string
required
Pattern: ^\d+$

Query Parameters

​
limit
integer
default:10

Number of messages to return (max 10)

Required range: 1 <= x <= 10
​
offset
integer | null

Number of messages to skip (for pagination)

Required range: x >= 0
​
query
string

Search/filter text

Maximum string length: 100
​
last_id
string | null

ID of the last message from previous page. Used for cursor pagination.

​
first_id
string | null

Include this message ID as the first message in the results. Used to retrieve messages from e.g. the Search Chat Messages endpoint IDs.

​
include_users
boolean | null

Include user data in the response

Response

Successful response

​
list
object[]
required
​
hasMore
boolean
required
​
nextLastId
string

Pagination cursor — pass as last_id to fetch the next page