Search chats
GET/v1/chats/search
Search chats by title, network, or participant names.
Query Parameters
includeMuted: optional boolean
Include chats marked as Muted by the user, which are usually less important. Default: true. Set to false if the user wants a more refined search.
lastActivityAfter: optional string
Only include chats with last activity after this ISO 8601 datetime.
formatdate-time
lastActivityBefore: optional string
Only include chats with last activity before this ISO 8601 datetime.
formatdate-time
limit: optional number
Set the maximum number of chats to retrieve. Valid range: 1-200, default is 50
minimum1
maximum200
Search chats
curl http://localhost:23373/v1/chats/search \
-H "Authorization: Bearer $BEEPER_ACCESS_TOKEN"{
"hasMore": true,
"items": [
{
"id": "!KPFTtZYWuERwib8T702N9IfqiCc:ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc.local-whatsapp.localhost",
"accountID": "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc",
"network": "WhatsApp",
"participants": {
"hasMore": true,
"items": [
{
"id": "@15550101002:local-whatsapp.localhost",
"cannotMessage": false,
"email": "email",
"fullName": "Kishan Bagaria",
"imgURL": "imgURL",
"isSelf": false,
"phoneNumber": "+15550101002",
"username": "username",
"isAdmin": true,
"isNetworkBot": true,
"isPending": true
},
{
"id": "@15550101003:local-whatsapp.localhost",
"cannotMessage": false,
"email": "email",
"fullName": "Gerardo Rodrigez",
"imgURL": "imgURL",
"isSelf": false,
"phoneNumber": "+15550101003",
"username": "username",
"isAdmin": true,
"isNetworkBot": true,
"isPending": true
}
],
"total": 5
},
"title": "Family Travel Planning",
"type": "group",
"unreadCount": 3,
"capabilities": {
"allowedReactions": [
"string"
],
"archive": true,
"attachments": {
"foo": {
"mimeTypes": {
"foo": -2
},
"caption": -2,
"maxCaptionLength": 0,
"maxDuration": 0,
"maxHeight": 0,
"maxSize": 0,
"maxWidth": 0,
"viewOnce": true
}
},
"customEmojiReactions": true,
"delete": -2,
"deleteChat": true,
"deleteChatForEveryone": true,
"deleteForMe": true,
"deleteMaxAge": 0,
"disappearingTimer": {
"omitEmptyTimer": true,
"timers": [
0
],
"types": [
"afterRead"
]
},
"edit": -2,
"editMaxAge": 0,
"editMaxCount": 0,
"formatting": {
"foo": -2
},
"locationMessage": -2,
"markAsUnread": true,
"maxTextLength": 0,
"messageRequest": {
"acceptWithButton": -2,
"acceptWithMessage": -2
},
"participantActions": {
"ban": -2,
"invite": -2,
"kick": -2,
"leave": -2,
"revokeInvite": -2
},
"poll": -2,
"reaction": -2,
"reactionCount": 0,
"readReceipts": true,
"reply": -2,
"state": {
"avatar": {
"level": -2
},
"description": {
"level": -2
},
"disappearingTimer": {
"level": -2
},
"title": {
"level": -2
}
},
"thread": -2,
"typingNotifications": true
},
"description": "description",
"draft": {
"text": "text",
"attachments": {
"foo": {
"id": "id",
"type": "file",
"audioDurationSeconds": 0,
"fileName": "fileName",
"filePath": "filePath",
"fileSize": 0,
"mimeType": "mimeType",
"size": {
"height": 0,
"width": 0
},
"stickerID": "stickerID"
}
}
},
"imgURL": "imgURL",
"isArchived": false,
"isLowPriority": true,
"isMarkedUnread": true,
"isMuted": false,
"isPinned": true,
"isReadOnly": true,
"lastActivity": "2025-08-31T19:41:41.000Z",
"lastReadMessageSortKey": "449706228480",
"localChatID": "1229391",
"messageExpirySeconds": 0,
"reminder": {
"dismissOnIncomingMessage": true,
"remindAt": "2025-08-31T23:30:12.520Z"
},
"snooze": {
"snoozeUntil": "2025-08-31T23:30:12.520Z",
"userSnoozedAt": "2025-08-31T23:30:12.520Z"
},
"unreadMentionsCount": 0
},
{
"id": "!discord_109876543210987654:beeper.com",
"accountID": "discordgo",
"network": "Discord",
"participants": {
"hasMore": true,
"items": [
{
"id": "@discord_221590782384013314:beeper.com",
"cannotMessage": false,
"email": "email",
"fullName": "Kishan Bagaria",
"imgURL": "imgURL",
"isSelf": false,
"phoneNumber": "phoneNumber",
"username": "kishan",
"isAdmin": true,
"isNetworkBot": true,
"isPending": true
},
{
"id": "@discord_854231905641922560:beeper.com",
"cannotMessage": false,
"email": "email",
"fullName": "Matt Wondra",
"imgURL": "imgURL",
"isSelf": false,
"phoneNumber": "phoneNumber",
"username": "mattwondra",
"isAdmin": true,
"isNetworkBot": true,
"isPending": true
}
],
"total": 6
},
"title": "Beeper Client API",
"type": "group",
"unreadCount": 0,
"capabilities": {
"allowedReactions": [
"string"
],
"archive": true,
"attachments": {
"foo": {
"mimeTypes": {
"foo": -2
},
"caption": -2,
"maxCaptionLength": 0,
"maxDuration": 0,
"maxHeight": 0,
"maxSize": 0,
"maxWidth": 0,
"viewOnce": true
}
},
"customEmojiReactions": true,
"delete": -2,
"deleteChat": true,
"deleteChatForEveryone": true,
"deleteForMe": true,
"deleteMaxAge": 0,
"disappearingTimer": {
"omitEmptyTimer": true,
"timers": [
0
],
"types": [
"afterRead"
]
},
"edit": -2,
"editMaxAge": 0,
"editMaxCount": 0,
"formatting": {
"foo": -2
},
"locationMessage": -2,
"markAsUnread": true,
"maxTextLength": 0,
"messageRequest": {
"acceptWithButton": -2,
"acceptWithMessage": -2
},
"participantActions": {
"ban": -2,
"invite": -2,
"kick": -2,
"leave": -2,
"revokeInvite": -2
},
"poll": -2,
"reaction": -2,
"reactionCount": 0,
"readReceipts": true,
"reply": -2,
"state": {
"avatar": {
"level": -2
},
"description": {
"level": -2
},
"disappearingTimer": {
"level": -2
},
"title": {
"level": -2
}
},
"thread": -2,
"typingNotifications": true
},
"description": "description",
"draft": {
"text": "text",
"attachments": {
"foo": {
"id": "id",
"type": "file",
"audioDurationSeconds": 0,
"fileName": "fileName",
"filePath": "filePath",
"fileSize": 0,
"mimeType": "mimeType",
"size": {
"height": 0,
"width": 0
},
"stickerID": "stickerID"
}
}
},
"imgURL": "imgURL",
"isArchived": true,
"isLowPriority": true,
"isMarkedUnread": true,
"isMuted": false,
"isPinned": false,
"isReadOnly": true,
"lastActivity": "2025-08-31T18:05:20.648Z",
"lastReadMessageSortKey": "449706782720",
"localChatID": "1229078",
"messageExpirySeconds": 0,
"reminder": {
"dismissOnIncomingMessage": true,
"remindAt": "2025-08-31T23:30:12.520Z"
},
"snooze": {
"snoozeUntil": "2025-08-31T23:30:12.520Z",
"userSnoozedAt": "2025-08-31T23:30:12.520Z"
},
"unreadMentionsCount": 0
},
{
"id": "!twitter_dm_photomatt:local-twitter.localhost",
"accountID": "local-twitter_ba_gUU1IHNGo_CsTZLp0vDFUYk9EuE",
"network": "Twitter/X",
"participants": {
"hasMore": false,
"items": [
{
"id": "@photomatt:local-twitter.localhost",
"cannotMessage": false,
"email": "email",
"fullName": "Matt Mullenweg",
"imgURL": "imgURL",
"isSelf": false,
"phoneNumber": "phoneNumber",
"username": "photomatt",
"isAdmin": true,
"isNetworkBot": true,
"isPending": true
}
],
"total": 2
},
"title": "Matt Mullenweg",
"type": "single",
"unreadCount": 1,
"capabilities": {
"allowedReactions": [
"string"
],
"archive": true,
"attachments": {
"foo": {
"mimeTypes": {
"foo": -2
},
"caption": -2,
"maxCaptionLength": 0,
"maxDuration": 0,
"maxHeight": 0,
"maxSize": 0,
"maxWidth": 0,
"viewOnce": true
}
},
"customEmojiReactions": true,
"delete": -2,
"deleteChat": true,
"deleteChatForEveryone": true,
"deleteForMe": true,
"deleteMaxAge": 0,
"disappearingTimer": {
"omitEmptyTimer": true,
"timers": [
0
],
"types": [
"afterRead"
]
},
"edit": -2,
"editMaxAge": 0,
"editMaxCount": 0,
"formatting": {
"foo": -2
},
"locationMessage": -2,
"markAsUnread": true,
"maxTextLength": 0,
"messageRequest": {
"acceptWithButton": -2,
"acceptWithMessage": -2
},
"participantActions": {
"ban": -2,
"invite": -2,
"kick": -2,
"leave": -2,
"revokeInvite": -2
},
"poll": -2,
"reaction": -2,
"reactionCount": 0,
"readReceipts": true,
"reply": -2,
"state": {
"avatar": {
"level": -2
},
"description": {
"level": -2
},
"disappearingTimer": {
"level": -2
},
"title": {
"level": -2
}
},
"thread": -2,
"typingNotifications": true
},
"description": "description",
"draft": {
"text": "text",
"attachments": {
"foo": {
"id": "id",
"type": "file",
"audioDurationSeconds": 0,
"fileName": "fileName",
"filePath": "filePath",
"fileSize": 0,
"mimeType": "mimeType",
"size": {
"height": 0,
"width": 0
},
"stickerID": "stickerID"
}
}
},
"imgURL": "imgURL",
"isArchived": false,
"isLowPriority": true,
"isMarkedUnread": true,
"isMuted": true,
"isPinned": false,
"isReadOnly": true,
"lastActivity": "2025-08-31T12:30:15.123Z",
"lastReadMessageSortKey": "449705982340",
"localChatID": "1228956",
"messageExpirySeconds": 0,
"reminder": {
"dismissOnIncomingMessage": true,
"remindAt": "2025-08-31T23:30:12.520Z"
},
"snooze": {
"snoozeUntil": "2025-08-31T23:30:12.520Z",
"userSnoozedAt": "2025-08-31T23:30:12.520Z"
},
"unreadMentionsCount": 0
}
],
"newestCursor": "eyJ0cyI6MTc1NjY2OTMwMTAwMCwiaWQiOiIhblplWDdkZDY3X1JhUG5tV0dKSWpVa1Yyc3ZFOmJhX3NYZjBhZG5icjI4Ny5sb2NhbC10ZWxlZ3JhbS5sb2NhbGhvc3QiLCJzY29yZSI6MTAuNX0=",
"oldestCursor": "eyJ0cyI6MTc1NjY2NzEyMDY0OCwiaWQiOiIhS1BGVHRaWVd1RVJ3aWI4VDcwMjlOSWZxaUNjOmJhX0V2WURCQnNamlFSd0F5M1VPU1dxRzBMdVRWa2MiLCJzY29yZSI6MTJ9"
}Returns Examples
{
"hasMore": true,
"items": [
{
"id": "!KPFTtZYWuERwib8T702N9IfqiCc:ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc.local-whatsapp.localhost",
"accountID": "local-whatsapp_ba_EvYDBBsZbRQAy3UOSWqG0LuTVkc",
"network": "WhatsApp",
"participants": {
"hasMore": true,
"items": [
{
"id": "@15550101002:local-whatsapp.localhost",
"cannotMessage": false,
"email": "email",
"fullName": "Kishan Bagaria",
"imgURL": "imgURL",
"isSelf": false,
"phoneNumber": "+15550101002",
"username": "username",
"isAdmin": true,
"isNetworkBot": true,
"isPending": true
},
{
"id": "@15550101003:local-whatsapp.localhost",
"cannotMessage": false,
"email": "email",
"fullName": "Gerardo Rodrigez",
"imgURL": "imgURL",
"isSelf": false,
"phoneNumber": "+15550101003",
"username": "username",
"isAdmin": true,
"isNetworkBot": true,
"isPending": true
}
],
"total": 5
},
"title": "Family Travel Planning",
"type": "group",
"unreadCount": 3,
"capabilities": {
"allowedReactions": [
"string"
],
"archive": true,
"attachments": {
"foo": {
"mimeTypes": {
"foo": -2
},
"caption": -2,
"maxCaptionLength": 0,
"maxDuration": 0,
"maxHeight": 0,
"maxSize": 0,
"maxWidth": 0,
"viewOnce": true
}
},
"customEmojiReactions": true,
"delete": -2,
"deleteChat": true,
"deleteChatForEveryone": true,
"deleteForMe": true,
"deleteMaxAge": 0,
"disappearingTimer": {
"omitEmptyTimer": true,
"timers": [
0
],
"types": [
"afterRead"
]
},
"edit": -2,
"editMaxAge": 0,
"editMaxCount": 0,
"formatting": {
"foo": -2
},
"locationMessage": -2,
"markAsUnread": true,
"maxTextLength": 0,
"messageRequest": {
"acceptWithButton": -2,
"acceptWithMessage": -2
},
"participantActions": {
"ban": -2,
"invite": -2,
"kick": -2,
"leave": -2,
"revokeInvite": -2
},
"poll": -2,
"reaction": -2,
"reactionCount": 0,
"readReceipts": true,
"reply": -2,
"state": {
"avatar": {
"level": -2
},
"description": {
"level": -2
},
"disappearingTimer": {
"level": -2
},
"title": {
"level": -2
}
},
"thread": -2,
"typingNotifications": true
},
"description": "description",
"draft": {
"text": "text",
"attachments": {
"foo": {
"id": "id",
"type": "file",
"audioDurationSeconds": 0,
"fileName": "fileName",
"filePath": "filePath",
"fileSize": 0,
"mimeType": "mimeType",
"size": {
"height": 0,
"width": 0
},
"stickerID": "stickerID"
}
}
},
"imgURL": "imgURL",
"isArchived": false,
"isLowPriority": true,
"isMarkedUnread": true,
"isMuted": false,
"isPinned": true,
"isReadOnly": true,
"lastActivity": "2025-08-31T19:41:41.000Z",
"lastReadMessageSortKey": "449706228480",
"localChatID": "1229391",
"messageExpirySeconds": 0,
"reminder": {
"dismissOnIncomingMessage": true,
"remindAt": "2025-08-31T23:30:12.520Z"
},
"snooze": {
"snoozeUntil": "2025-08-31T23:30:12.520Z",
"userSnoozedAt": "2025-08-31T23:30:12.520Z"
},
"unreadMentionsCount": 0
},
{
"id": "!discord_109876543210987654:beeper.com",
"accountID": "discordgo",
"network": "Discord",
"participants": {
"hasMore": true,
"items": [
{
"id": "@discord_221590782384013314:beeper.com",
"cannotMessage": false,
"email": "email",
"fullName": "Kishan Bagaria",
"imgURL": "imgURL",
"isSelf": false,
"phoneNumber": "phoneNumber",
"username": "kishan",
"isAdmin": true,
"isNetworkBot": true,
"isPending": true
},
{
"id": "@discord_854231905641922560:beeper.com",
"cannotMessage": false,
"email": "email",
"fullName": "Matt Wondra",
"imgURL": "imgURL",
"isSelf": false,
"phoneNumber": "phoneNumber",
"username": "mattwondra",
"isAdmin": true,
"isNetworkBot": true,
"isPending": true
}
],
"total": 6
},
"title": "Beeper Client API",
"type": "group",
"unreadCount": 0,
"capabilities": {
"allowedReactions": [
"string"
],
"archive": true,
"attachments": {
"foo": {
"mimeTypes": {
"foo": -2
},
"caption": -2,
"maxCaptionLength": 0,
"maxDuration": 0,
"maxHeight": 0,
"maxSize": 0,
"maxWidth": 0,
"viewOnce": true
}
},
"customEmojiReactions": true,
"delete": -2,
"deleteChat": true,
"deleteChatForEveryone": true,
"deleteForMe": true,
"deleteMaxAge": 0,
"disappearingTimer": {
"omitEmptyTimer": true,
"timers": [
0
],
"types": [
"afterRead"
]
},
"edit": -2,
"editMaxAge": 0,
"editMaxCount": 0,
"formatting": {
"foo": -2
},
"locationMessage": -2,
"markAsUnread": true,
"maxTextLength": 0,
"messageRequest": {
"acceptWithButton": -2,
"acceptWithMessage": -2
},
"participantActions": {
"ban": -2,
"invite": -2,
"kick": -2,
"leave": -2,
"revokeInvite": -2
},
"poll": -2,
"reaction": -2,
"reactionCount": 0,
"readReceipts": true,
"reply": -2,
"state": {
"avatar": {
"level": -2
},
"description": {
"level": -2
},
"disappearingTimer": {
"level": -2
},
"title": {
"level": -2
}
},
"thread": -2,
"typingNotifications": true
},
"description": "description",
"draft": {
"text": "text",
"attachments": {
"foo": {
"id": "id",
"type": "file",
"audioDurationSeconds": 0,
"fileName": "fileName",
"filePath": "filePath",
"fileSize": 0,
"mimeType": "mimeType",
"size": {
"height": 0,
"width": 0
},
"stickerID": "stickerID"
}
}
},
"imgURL": "imgURL",
"isArchived": true,
"isLowPriority": true,
"isMarkedUnread": true,
"isMuted": false,
"isPinned": false,
"isReadOnly": true,
"lastActivity": "2025-08-31T18:05:20.648Z",
"lastReadMessageSortKey": "449706782720",
"localChatID": "1229078",
"messageExpirySeconds": 0,
"reminder": {
"dismissOnIncomingMessage": true,
"remindAt": "2025-08-31T23:30:12.520Z"
},
"snooze": {
"snoozeUntil": "2025-08-31T23:30:12.520Z",
"userSnoozedAt": "2025-08-31T23:30:12.520Z"
},
"unreadMentionsCount": 0
},
{
"id": "!twitter_dm_photomatt:local-twitter.localhost",
"accountID": "local-twitter_ba_gUU1IHNGo_CsTZLp0vDFUYk9EuE",
"network": "Twitter/X",
"participants": {
"hasMore": false,
"items": [
{
"id": "@photomatt:local-twitter.localhost",
"cannotMessage": false,
"email": "email",
"fullName": "Matt Mullenweg",
"imgURL": "imgURL",
"isSelf": false,
"phoneNumber": "phoneNumber",
"username": "photomatt",
"isAdmin": true,
"isNetworkBot": true,
"isPending": true
}
],
"total": 2
},
"title": "Matt Mullenweg",
"type": "single",
"unreadCount": 1,
"capabilities": {
"allowedReactions": [
"string"
],
"archive": true,
"attachments": {
"foo": {
"mimeTypes": {
"foo": -2
},
"caption": -2,
"maxCaptionLength": 0,
"maxDuration": 0,
"maxHeight": 0,
"maxSize": 0,
"maxWidth": 0,
"viewOnce": true
}
},
"customEmojiReactions": true,
"delete": -2,
"deleteChat": true,
"deleteChatForEveryone": true,
"deleteForMe": true,
"deleteMaxAge": 0,
"disappearingTimer": {
"omitEmptyTimer": true,
"timers": [
0
],
"types": [
"afterRead"
]
},
"edit": -2,
"editMaxAge": 0,
"editMaxCount": 0,
"formatting": {
"foo": -2
},
"locationMessage": -2,
"markAsUnread": true,
"maxTextLength": 0,
"messageRequest": {
"acceptWithButton": -2,
"acceptWithMessage": -2
},
"participantActions": {
"ban": -2,
"invite": -2,
"kick": -2,
"leave": -2,
"revokeInvite": -2
},
"poll": -2,
"reaction": -2,
"reactionCount": 0,
"readReceipts": true,
"reply": -2,
"state": {
"avatar": {
"level": -2
},
"description": {
"level": -2
},
"disappearingTimer": {
"level": -2
},
"title": {
"level": -2
}
},
"thread": -2,
"typingNotifications": true
},
"description": "description",
"draft": {
"text": "text",
"attachments": {
"foo": {
"id": "id",
"type": "file",
"audioDurationSeconds": 0,
"fileName": "fileName",
"filePath": "filePath",
"fileSize": 0,
"mimeType": "mimeType",
"size": {
"height": 0,
"width": 0
},
"stickerID": "stickerID"
}
}
},
"imgURL": "imgURL",
"isArchived": false,
"isLowPriority": true,
"isMarkedUnread": true,
"isMuted": true,
"isPinned": false,
"isReadOnly": true,
"lastActivity": "2025-08-31T12:30:15.123Z",
"lastReadMessageSortKey": "449705982340",
"localChatID": "1228956",
"messageExpirySeconds": 0,
"reminder": {
"dismissOnIncomingMessage": true,
"remindAt": "2025-08-31T23:30:12.520Z"
},
"snooze": {
"snoozeUntil": "2025-08-31T23:30:12.520Z",
"userSnoozedAt": "2025-08-31T23:30:12.520Z"
},
"unreadMentionsCount": 0
}
],
"newestCursor": "eyJ0cyI6MTc1NjY2OTMwMTAwMCwiaWQiOiIhblplWDdkZDY3X1JhUG5tV0dKSWpVa1Yyc3ZFOmJhX3NYZjBhZG5icjI4Ny5sb2NhbC10ZWxlZ3JhbS5sb2NhbGhvc3QiLCJzY29yZSI6MTAuNX0=",
"oldestCursor": "eyJ0cyI6MTc1NjY2NzEyMDY0OCwiaWQiOiIhS1BGVHRaWVd1RVJ3aWI4VDcwMjlOSWZxaUNjOmJhX0V2WURCQnNamlFSd0F5M1VPU1dxRzBMdVRWa2MiLCJzY29yZSI6MTJ9"
}