Conversations

Get a list of user conversations

Get a list of user conversations.

get/conversations/

Query parameters

pageinteger

starter_idinteger

receiver_idinteger

starredboolean

Only gets starred conversations if specified

unreadboolean

Only gets unread conversations if specified

label_idinteger

Response

Changes

Changed in 2 of the 7 revisions of this API.2913

Mar 18, 2026e271d0e41f6d110See the full diff
- ▲
  the response's property type changed from string to object for status
  response-property-type-changed
- ○
  api operation id get_conversations_ removed and replaced with getConversations
  api-operation-id-removed
- ○
  the endpoint scheme security XF-Api-Key was added to the API
  api-security-added
- ○
  the endpoint scheme security XF-OAuth2 was added to the API
  api-security-added
- ○
  added the new optional header request parameter XF-Api-User to all path's operations
  new-optional-request-default-parameter-to-existing-path
- ○
  added the new optional query request parameter api_bypass_permissions to all path's operations
  new-optional-request-default-parameter-to-existing-path
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
- ○
  added the optional property / to the response with the status
  response-optional-property-added
This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
Feb 3, 2026fc0a40f3b859193See the full diff
- ▲
  the response's property type changed from object to string for status
  response-property-type-changed
- ●
  the optional response header XF-Latest-Api-Version removed for the status 200
  optional-response-header-removed
- ●
  the optional response header XF-Request-User removed for the status 200
  optional-response-header-removed
- ●
  the optional response header XF-Request-User-Extras removed for the status 200
  optional-response-header-removed
- ●
  the optional response header XF-Used-Api-Version removed for the status 200
  optional-response-header-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ●
  removed the optional property / from the response with the status
  response-optional-property-removed
- ○
  api operation id getConversations removed and replaced with get_conversations_
  api-operation-id-removed
- ○
  the endpoint scheme security XF-Api-Key was removed from the API
  api-security-removed
- ○
  the endpoint scheme security XF-OAuth2 was removed from the API
  api-security-removed
This revision also has 18 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history