Get all chatrooms (manager)

GET /manager/chatrooms
Bearer token

Query parameters

  • sort string

    Sort the chatrooms by last_message_date (-last_message_date: descending, last_message_date: ascending)

    Values are id_chatroom, date_insert, last_message_date, or last_rating.

  • filter[type_chatroom] string

    Filter the chatrooms by type_chatroom (0: one to one , 7: one to many)

    Values are 0 or 7.

  • filter[type_discussion] string

    Filter the chatrooms by type_discussion(0: between members, 1: between external, 2: between members and external)

    Values are 0, 1, or 2.

  • filter[source] string

    Filter the chatrooms by source

    Values are hot_list, waiting_list, or direct.

  • filter[dialogue] string

    established : chatrooms with at least two authors, not established : chatrooms with only one author

    Values are established or not_established.

  • filter[last_rating] string

    Filter the chatrooms by their last_rating

    Values are not_rated, 0, 1, 2, 3, 4, or 5.

  • filter[ambassador] integer

    Filter the chatrooms by having messages posted by the ambassador

  • page integer

    page number

  • per_page integer

    number of items per page

Responses

  • 200 application/json

    Returns all the chatrooms (paginated)

    Hide response attributes Show response attributes object
    • current_page integer(int32)
    • data array[object]

      Additional properties are allowed.

    • first_page_url string
    • from integer(int32)
    • last_page integer(int32)
    • last_page_url string
    • links array[object]
      Hide links attributes Show links attributes object
      • url string(nullable)
      • label string
      • active boolean
    • next_page_url string
    • path string
    • per_page integer(int32)
    • prev_page_url string(nullable)
    • to integer(int32)
    • total integer(int32)
  • 401 application/json

    Unauthorized.

    Hide response attribute Show response attribute object
    • message string
  • 403

    Forbidden - You don't have permission to access this route

GET /manager/chatrooms 
curl \
 --request GET 'https://domain.tld/api/v2/manager/chatrooms' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "current_page": 42,
  "data": [
    {}
  ],
  "first_page_url": "string",
  "from": 42,
  "last_page": 42,
  "last_page_url": "string",
  "links": [
    {
      "url": "string",
      "label": "string",
      "active": true
    }
  ],
  "next_page_url": "string",
  "path": "string",
  "per_page": 42,
  "prev_page_url": "string",
  "to": 42,
  "total": 42
}
Response examples (401) 
{
  "message": "Unauthorized."
}