GET
/
v2
/
messages
List projected canonical messages
curl --request GET \
  --url https://api-v2.watchcollect.com/v2/messages \
  --header 'Authorization: Bearer <token>'
{
  "items": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "primary_occurrence_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "message_timestamp_ms": 123,
      "first_seen_at_ms": 123,
      "last_seen_at_ms": 123,
      "sender": {
        "contact_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "phone_number": "<string>",
        "lid": "<string>",
        "display_name": "<string>",
        "country_prefix": "<string>"
      },
      "group_names": [
        "<string>"
      ],
      "group_ids": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "group_count": 123,
      "occurrence_count": 123,
      "has_media": true,
      "is_edited": true,
      "is_revoked": true,
      "message_text": "<string>",
      "primary_media_asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "primary_media_url": "<string>"
    }
  ],
  "has_more": true,
  "next_cursor": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
view_id
string<uuid>

Saved view filters are combined with request query params using AND semantics.

​
q
string

Indexed search over message text. Combined with saved-view text_search using AND.

Minimum string length: 3
​
search_mode
enum<string>
default:broad

Search behavior for q. broad matches any normalized word; exact matches the normalized phrase; exact_light matches ordered words within a small positional gap.

Available options:
broad,
exact,
exact_light
​
classification_status
enum<string>[]

Comma-separated classification statuses.

Available options:
pending,
completed,
skipped,
failed
​
intent
enum<string>[]

Comma-separated message intents.

Available options:
selling,
buying,
personal,
unknown
​
group_id
string<uuid>[]

Comma-separated group IDs.

​
contact_id
string<uuid>[]

Comma-separated contact IDs.

​
country_prefix
string[]

Comma-separated E.164 country phone prefixes without a leading plus sign.

​
from_ms
integer<int64>
​
to_ms
integer<int64>
​
last_seen_from_ms
integer<int64>
​
last_seen_to_ms
integer<int64>
​
include_revoked
boolean
default:false
​
cursor
string
​
page_size
integer
default:50
Required range: 1 <= x <= 200

Response

Cursor page of canonical messages.

​
items
object[]
required
​
has_more
boolean
required
​
next_cursor
string | null