Company messaging

List conversations

List a company admin’s conversations, grouped by inbox template, as that admin sees them.

The request acts as the company admin whose email you pass in user[email]. It requires a Bearer token for a company admin (for example a company API token) whose role includes the messaging view permission. If user[email] does not match an admin of the company, the request returns 403.

The response has one key per requested template. Each template’s value is a two-item array: a pagination object, then an object holding that template’s items. page and per_page apply to every template. new_messages is never paginated and returns every match on one page.

GET

api

company

messaging

conversations

List conversations

curl --request GET \
  --url https://api.fluid.app/api/company/messaging/conversations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fluid.app/api/company/messaging/conversations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fluid.app/api/company/messaging/conversations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fluid.app/api/company/messaging/conversations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/company/messaging/conversations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "pinned": [
    {
      "pagination": {
        "current": 1,
        "previous": null,
        "next": null,
        "per_page": 5,
        "pages": 1,
        "count": 1
      }
    },
    {
      "items": [
        {
          "id": 90412,
          "type": "GroupConversation",
          "kind": "group",
          "name": "Spring launch team",
          "description": "Planning the April product launch",
          "status": "open",
          "conversation_type": "internal",
          "broadcasting": null,
          "auto_add_recipients": null,
          "announcing": false,
          "avatar_background_color": null,
          "avatar_emoji": null,
          "avatar_url": null,
          "image_url": null,
          "created_at": "2026-09-12T15:42:07Z",
          "pinned_messages_count": 1,
          "total_recipients": 3,
          "unread": true,
          "pinned": true,
          "muted": false,
          "unread_messages_count": 2,
          "scheduled_messages_count": 0,
          "email_enabled?": false,
          "sms_enabled?": false,
          "messaging_enabled?": true,
          "draft_message": null,
          "recipients": [
            {
              "id": 48102,
              "receivable_id": 7731,
              "receivable_type": "UserCompany",
              "first_name": "Dana",
              "last_name": "Whitfield",
              "status": "active",
              "last_online": "2026-09-30T15:40:12Z",
              "avatar_background": "#4F46E5",
              "avatar_url": null,
              "image_url": null,
              "country_name": "United States",
              "pro_user": true,
              "blocked": false,
              "left_conversation_at": null,
              "discarded_at": null
            }
          ],
          "creator": {
            "id": 48102,
            "first_name": "Dana",
            "last_name": "Whitfield",
            "avatar_background": "#4F46E5",
            "image_url": null,
            "pro_user": true,
            "blocked": false,
            "blocker": false,
            "discarded_at": null
          }
        }
      ]
    }
  ],
  "channels": [
    {
      "pagination": {
        "current": 1,
        "previous": null,
        "next": null,
        "per_page": 5,
        "pages": 0,
        "count": 0
      }
    },
    {
      "items": []
    }
  ]
}

{
  "message": "Invalid credentials."
}

{
  "error": "You do not have sufficient privileges to perform this action."
}

Authorizations

Authorization

string

header

required

Bearer token authentication

Query Parameters

user[email]

string<email>

required

Email of the company admin to act as.

templates

string

Comma-separated inbox templates to return. Unknown names are ignored, and with no templates the response is an empty object. Available templates: new_messages, pinned, team_groups, downline, team_directs, teams, teams_unread, teams_read, channels, channels_unread, channels_read, sms, sms_read, sms_unread, email, email_read, email_unread, customers, customers_unread, customers_read, archived_sms, archived_email, archived_directs, archived_groups, archived_teams, archived_channels, archived_customers, and bots. Add announcement_channel or my_downline to also return the company's announcement channel or the admin's downline conversation as a single object.

page

integer

default:1

Page number for each paginated template.

Required range: x >= 1

per_page

integer

default:5

Conversations per page for each paginated template.

Required range: x >= 1

string

Only conversations whose name or participant names, emails, or phone numbers match this text.

Response

The requested templates, each with a page of conversations.

Conversations keyed by the requested inbox template.

announcement_channel

object | null

The company's announcement channel, when announcement_channel is requested.

Show child attributes

my_downline

object | null

The acting admin's downline conversation, when my_downline is requested.

Show child attributes

{key}

tuple

One inbox template's page of conversations, as a two-item array. The first item holds the pagination details and the second holds the conversations.

Show child attributes

List conversations

curl --request GET \
  --url https://api.fluid.app/api/company/messaging/conversations \
  --header 'Authorization: Bearer <token>'

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.fluid.app/api/company/messaging/conversations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fluid.app/api/company/messaging/conversations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fluid.app/api/company/messaging/conversations"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fluid.app/api/company/messaging/conversations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "pinned": [
    {
      "pagination": {
        "current": 1,
        "previous": null,
        "next": null,
        "per_page": 5,
        "pages": 1,
        "count": 1
      }
    },
    {
      "items": [
        {
          "id": 90412,
          "type": "GroupConversation",
          "kind": "group",
          "name": "Spring launch team",
          "description": "Planning the April product launch",
          "status": "open",
          "conversation_type": "internal",
          "broadcasting": null,
          "auto_add_recipients": null,
          "announcing": false,
          "avatar_background_color": null,
          "avatar_emoji": null,
          "avatar_url": null,
          "image_url": null,
          "created_at": "2026-09-12T15:42:07Z",
          "pinned_messages_count": 1,
          "total_recipients": 3,
          "unread": true,
          "pinned": true,
          "muted": false,
          "unread_messages_count": 2,
          "scheduled_messages_count": 0,
          "email_enabled?": false,
          "sms_enabled?": false,
          "messaging_enabled?": true,
          "draft_message": null,
          "recipients": [
            {
              "id": 48102,
              "receivable_id": 7731,
              "receivable_type": "UserCompany",
              "first_name": "Dana",
              "last_name": "Whitfield",
              "status": "active",
              "last_online": "2026-09-30T15:40:12Z",
              "avatar_background": "#4F46E5",
              "avatar_url": null,
              "image_url": null,
              "country_name": "United States",
              "pro_user": true,
              "blocked": false,
              "left_conversation_at": null,
              "discarded_at": null
            }
          ],
          "creator": {
            "id": 48102,
            "first_name": "Dana",
            "last_name": "Whitfield",
            "avatar_background": "#4F46E5",
            "image_url": null,
            "pro_user": true,
            "blocked": false,
            "blocker": false,
            "discarded_at": null
          }
        }
      ]
    }
  ],
  "channels": [
    {
      "pagination": {
        "current": 1,
        "previous": null,
        "next": null,
        "per_page": 5,
        "pages": 0,
        "count": 0
      }
    },
    {
      "items": []
    }
  ]
}

{
  "message": "Invalid credentials."
}

{
  "error": "You do not have sufficient privileges to perform this action."
}

Overview

Storefront

Commerce

Checkout

Members

Messaging

People

Payments

DAM

Website

Portal

Content and tools

Analytics

Sales channels

Settings

FairShare SDK

Droplets

Developers

Portal & Widgets

List conversations

Authorizations

Query Parameters

Response