Return single Chatroom

GET /api/chat/chatroom/{identifier}

Session token Jwt token internal Login config

Path parameters

identifier string Required

Query parameters

iw-build-id string

build id of the client
iw-package-id string

package id of the client

Responses

200 application/json

Return single Chatroom
Hide response attributes Show response attributes object
- id integer
- token string
- notification_token string
- participants array[object]
  
  Hide participants attributes Show participants attributes object
  
  id integer
  
  participant_type string
  
  first_name string
  
  last_name string
  
  nickname string
  
  preferred_color_hex string
  
  avatar_token string
  
  last_read_at string(date-time)
  
  room_admin boolean
  
  can_write boolean
  
  is_muted boolean
  
  auto_created boolean
  
  auto_reply boolean
  
  ai_auto_close_secret_word string
  
  ai_prompt string
  
  ai_number_of_context_messages integer
  
  created string(date-time)
  
  updated string(date-time)
  
  deleted boolean
  
  name string
  
  image_url string
- last_read_at string(date-time)
- created string(date-time)
- updated string(date-time)
- deleted boolean
- name string
- image_url string

GET /api/chat/chatroom/{identifier}

curl \
 --request GET 'https://replace-with-own-host.iw-erp.de/api/chat/chatroom/{identifier}' \
 --header "x-session-token: $API_KEY"

Response examples (200)

{
  "id": 42,
  "token": "string",
  "notification_token": "string",
  "participants": [
    {
      "id": 42,
      "participant_type": "string",
      "first_name": "string",
      "last_name": "string",
      "nickname": "string",
      "preferred_color_hex": "string",
      "avatar_token": "string",
      "last_read_at": "2025-05-04T09:42:00Z",
      "room_admin": true,
      "can_write": true,
      "is_muted": true,
      "auto_created": true,
      "auto_reply": true,
      "ai_auto_close_secret_word": "string",
      "ai_prompt": "string",
      "ai_number_of_context_messages": 42,
      "created": "2025-05-04T09:42:00Z",
      "updated": "2025-05-04T09:42:00Z",
      "deleted": true,
      "name": "string",
      "image_url": "string"
    }
  ],
  "last_read_at": "2025-05-04T09:42:00Z",
  "created": "2025-05-04T09:42:00Z",
  "updated": "2025-05-04T09:42:00Z",
  "deleted": true,
  "name": "string",
  "image_url": "string"
}