# Returns a list of all Chatrooms

**GET /api/cp/chat/chatroom**




## Servers
- https://replace-with-own-host.iw-erp.de: https://replace-with-own-host.iw-erp.de ()


## Authentication methods
- Session token
- Jwt token internal
- Login config


## Parameters


### Query parameters
- **name** (string)
  Requires access right: SCOPE_LIST, LOGGED_IN_LIST, C1, C2
- **created** (string)
  Requires access right: SCOPE_LIST, LOGGED_IN_LIST, C1, C2
- **company** (string)
  Requires access right: SCOPE_LIST, LOGGED_IN_LIST, C1, C2
- **event** (string)
  Requires access right: SCOPE_LIST, LOGGED_IN_LIST, C1, C2
- **deleted** (boolean)
  This property is used to mark an entity as deleted / archived | Requires access right: SCOPE_LIST, C1
- **id** (string)
  Requires access right: C1, C2
- **searchString** (string)
  text to search for in the list
- **orderFieldName** (string)
  name of the order field
- **orderFieldSort** (string)
  sorting mode
- **page** (integer)
  page of the list
- **pageSize** (integer)
  number of entries for each page
- **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
Returns a list of all Chatrooms

#### Body: application/json (array[object])
- **unread_count** (integer)

- **is_unread** (boolean)

- **id** (integer)

- **notification_token** (string)

- **name** (string)

- **image_url** (string)



[Powered by Bump.sh](https://bump.sh)