Dynamo Developer DocsDynamo Developer Docs
External APIVIPVIP Messages

List VIP user messages

VIP user messages in a window, newest first. With `label` set, only messages carrying that built-in label value or custom AI label id — the drill-down behind a label-overview count; without it, every message in the window. Paged with a `before` timestamp cursor (echo a response's `nextCursor` back). Window capped at 31 days; VIP workspaces only.

get/vip-messages

Beta

The External API is in beta. Endpoints, parameters, and response shapes may change — including breaking changes — in future releases. Pin to documented behavior before relying on it in production.

Authorization

x-api-key x-date x-signature x-api-version
x-api-key<token>

Your API key (the ApiKeys document id).

In: header

x-date<token>

Current timestamp as an IMF-fixdate string (GMT, US locale) "EEE, dd MMM yyyy HH:mm:ss z", e.g. "Sun, 06 Dec 2020 12:59:11 GMT". 30-second TTL.

In: header

x-signature<token>

HMAC-SHA256 of the x-date string keyed by your secret, lowercase hex.

In: header

x-api-version<token>

API version you're coding against — currently 1. Required; a missing or unsupported value returns 400 with Missing or unsupported x-api-version header. Supported versions: 1.

In: header

Query Parameters

workspaceId*string

The VIP workspace id (from GET /workspaces).

mediumId*string

The channel id (from GET /channels).

startDate*string

Window start — ISO date (e.g. 2026-06-01).

endDate*string

Window end — ISO date (a date-only value is inclusive of that whole day).

label?string

A built-in label value (e.g. frustrated) or a custom AI label id.

contentType?string

Narrow to one entry kind.

limit?integer

Max messages per page.

before?integer

Opaque page cursor — a previous response's nextCursor (an epoch-ms timestamp).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

Try it

read-only

Kept in this tab only and signed in your browser — your secret never leaves your device.

Query

Enter your key and secret to send.

curl -X GET "https://example.com/vip-messages?workspaceId=AbC123XyZ&mediumId=FB_PAGE_123456789012345&startDate=2026-06-01&endDate=2026-06-30"
{  "items": [    {      "timestamp": 0,      "date": "2019-08-24T14:15:22Z",      "conversationId": "string",      "userName": "string",      "kind": "text",      "source": "string",      "labels": [        "string"      ],      "customLabelIds": [        "string"      ],      "text": "string"    }  ],  "returned": 0,  "mayHaveMore": true,  "nextCursor": "string"}
{  "message": "string"}
{  "message": "string"}
{  "message": "string"}
{  "message": "string"}
{  "error": [    {      "message": "string",      "path": [        "string"      ],      "type": "string",      "context": {}    }  ]}

Export VIP users to CSV

Export all matched VIP users to a CSV and return `{ totalCount, csvUrl }`. Same filters as the list route, but returns every matched row rather than a page.

Export VIP user messages to CSV

Export all VIP user messages in a window to a CSV and return `{ totalCount, csvUrl }`. Same filters and 31-day cap as the list route, but returns every matching row rather than a capped page.