List direct message conversations
Returns the Instagram direct message threads PostZen holds for the accounts this key can reach, newest activity first, and refreshes that stored copy from the platform as a side effect (throttled per account, so a tight polling loop costs nothing extra). meta reports which accounts could not be refreshed; their stored threads are still returned. Read-only and read-write API keys are accepted.
Request
- Base URL: https://api.postzen.dev
- URL: https://api.postzen.dev/v1/inbox/conversations
- Auth: HTTP bearer
Query parameters
Restrict the read to one connected account. Omitted, every Instagram account the key can reach is queried.
Restrict the read to accounts on one profile.
Restrict the read to one platform. Direct messages cover Instagram only; any other value is a validation error.
Return only active or only archived threads. Archive state is PostZen-local.
Order by updatedTime.
Page size.
Opaque pagination cursor. Pass pagination.nextCursor from the previous response.
Response
Conversations returned.
Changes
No recorded changes to this operation across all 1 revision of this API.