Skip to main content
GET
/
v2
/
access
/
chats
Chats list
curl --request GET \
  --url https://api-next.ofauth.com/v2/access/chats \
  --header 'apiKey: <api-key>' \
  --header 'x-connection-id: <api-key>'
{
  "list": [
    {
      "withUser": {
        "id": 123,
        "_view": "<string>"
      },
      "canNotSendReason": true,
      "canSendMessage": true,
      "canGoToProfile": true,
      "unreadMessagesCount": 123,
      "hasUnreadTips": true,
      "isMutedNotifications": true,
      "lastMessage": {
        "id": 123,
        "text": "<string>",
        "fromUser": {
          "id": 123,
          "name": "<string>"
        },
        "media": [
          {
            "id": 123,
            "type": "photo",
            "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": "<unknown>",
        "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
      },
      "lastReadMessageId": 123,
      "hasPurchasedFeed": true,
      "countPinnedMessages": 123
    }
  ],
  "hasMore": true,
  "nextOffset": 123
}

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.

Query Parameters

limit
integer
default:10

Number of items to return (1-20, default: 10)

Required range: 1 <= x <= 20
offset
integer | null
default:0

Number of items to skip (default: 0)

Required range: x >= 0
order
enum<string>
default:recent

Sort order: recent (newest first) or old (oldest first)

Available options:
recent,
old
filter
enum<string>

Filter chats by type

Available options:
priority,
who_tipped,
unread
query
string

Search/filter text

Maximum string length: 100
userListId
integer

Filter to specific user list

Required range: x > 0

Response

Successful response

list
object[]
required
hasMore
boolean
required
nextOffset
number