Returns a list of all ChatroomParticipants

GET /api/chat/chatroom_participant

Session token Jwt token internal Login config

Query parameters

chatroom string

Requires access right: SCOPE_LIST
person string

Requires access right: SCOPE_LIST
company string

Requires access right: SCOPE_LIST
eventSignUp string

Requires access right: SCOPE_LIST
deleted boolean

This property is used to mark an entity as deleted / archived | Requires access right: SCOPE_LIST
searchString string

text to search for in the list
orderFieldName string

name of the order field
orderFieldSort string

sorting mode

Values are DESC or ASC.
page integer

page of the list

Default value is 0.
pageSize integer

number of entries for each page

Minimum value is 1, maximum value is 200. Default value is 50.
withMaxPageNumber string

returns the number of pages available as a header if this is set
iw-build-id string

build id of the client
iw-package-id string

package id of the client

Responses

200 application/json

Returns a list of all ChatroomParticipants
Hide response attributes Show response 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
- created string(date-time)
- updated string(date-time)
- deleted boolean
- name string
- image_url string

GET /api/chat/chatroom_participant

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

Response examples (200)

[
  {
    "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,
    "created": "2025-05-04T09:42:00Z",
    "updated": "2025-05-04T09:42:00Z",
    "deleted": true,
    "name": "string",
    "image_url": "string"
  }
]