> For the complete documentation index, see [llms.txt](https://talque.gitbook.io/public/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://talque.gitbook.io/public/json-api/room/talque-room-api.md).

# Talque Room API

## Read rooms by ID

> Looks up one or more rooms by their IDs.

```json
{"openapi":"3.0.3","info":{"title":"Talque Room API","version":"1.0.0"},"paths":{"/api/v1/room/read":{"post":{"summary":"Read rooms by ID","description":"Looks up one or more rooms by their IDs.","parameters":[{"name":"X-TQ-CLIENT-ID","in":"header","required":false,"schema":{"type":"string"},"description":"The API client ID for authentication."},{"name":"X-TQ-SECRET","in":"header","required":false,"schema":{"type":"string"},"description":"The API client secret for authentication."}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"orgId":{"type":"string","description":"The unique identifier of the organization."},"roomIdList":{"type":"array","items":{"type":"string"},"description":"List of room IDs to look up."}},"required":["orgId","roomIdList"]}}}},"responses":{"200":{"description":"Lookup completed (individual rooms may still be not found)","content":{"application/json":{"schema":{"type":"object","properties":{"orgId":{"type":"string","description":"The unique identifier of the organization."},"roomById":{"type":"object","additionalProperties":{"type":"object","properties":{"success":{"type":"boolean","description":"Whether the room was found."},"reason":{"type":"string","description":"Machine-readable result code."},"model":{"type":["object","null"],"properties":{"roomId":{"type":"string","description":"The unique identifier of the room."},"mtime":{"type":"integer","description":"Last modification time of the room (milliseconds since epoch)."},"order":{"type":"integer","description":"Sort key for ordering rooms in the UI."},"name":{"$schema":"http://json-schema.org/draft-04/schema","type":"object","properties":{"DE_DE":{"type":"string"},"EN_US":{"type":"string"},"FR_FR":{"type":"string"},"ES_ES":{"type":"string"},"PT_PT":{"type":"string"},"ZH_CN":{"type":"string"},"UK_UA":{"type":"string"},"AR_EG":{"type":"string"},"RU_RU":{"type":"string"},"FA_IR":{"type":"string"},"NL_NL":{"type":"string"}},"additionalProperties":false,"description":"Internal name of the room."},"pubName":{"$schema":"http://json-schema.org/draft-04/schema","type":"object","properties":{"DE_DE":{"type":"string"},"EN_US":{"type":"string"},"FR_FR":{"type":"string"},"ES_ES":{"type":"string"},"PT_PT":{"type":"string"},"ZH_CN":{"type":"string"},"UK_UA":{"type":"string"},"AR_EG":{"type":"string"},"RU_RU":{"type":"string"},"FA_IR":{"type":"string"},"NL_NL":{"type":"string"}},"additionalProperties":false,"description":"Public-facing name of the room shown to participants."},"color":{"type":["string","null"],"description":"HTML color code for the room."},"capacity":{"type":["integer","null"],"description":"Maximum occupancy of the room."},"extId":{"type":["string","null"],"description":"Optional external identifier."}},"required":["roomId","mtime","order","name","pubName"],"description":"The room data, or null if not found."}},"required":["success","reason","model"]},"description":"Map from room ID to its result."}},"required":["orgId","roomById"]}}}},"400":{"description":"Bad request (e.g., missing or invalid fields)"},"403":{"description":"Forbidden"},"404":{"description":"Organization not found"}}}}}}
```

## List rooms in an organization

> Returns rooms in the organization with optional pagination.

```json
{"openapi":"3.0.3","info":{"title":"Talque Room API","version":"1.0.0"},"paths":{"/api/v1/room/list":{"post":{"summary":"List rooms in an organization","description":"Returns rooms in the organization with optional pagination.","parameters":[{"name":"X-TQ-CLIENT-ID","in":"header","required":false,"schema":{"type":"string"},"description":"The API client ID for authentication."},{"name":"X-TQ-SECRET","in":"header","required":false,"schema":{"type":"string"},"description":"The API client secret for authentication."}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"orgId":{"type":"string","description":"The unique identifier of the organization."},"limit":{"type":"integer","description":"Maximum number of rooms to return."},"cursor":{"type":["string","null"],"description":"Pagination cursor from a previous response."}},"required":["orgId"]}}}},"responses":{"200":{"description":"List of rooms","content":{"application/json":{"schema":{"type":"object","properties":{"orgId":{"type":"string","description":"The unique identifier of the organization."},"rooms":{"type":"array","items":{"type":"object","properties":{"roomId":{"type":"string","description":"The unique identifier of the room."},"mtime":{"type":"integer","description":"Last modification time of the room (milliseconds since epoch)."},"order":{"type":"integer","description":"Sort key for ordering rooms in the UI."},"name":{"$schema":"http://json-schema.org/draft-04/schema","type":"object","properties":{"DE_DE":{"type":"string"},"EN_US":{"type":"string"},"FR_FR":{"type":"string"},"ES_ES":{"type":"string"},"PT_PT":{"type":"string"},"ZH_CN":{"type":"string"},"UK_UA":{"type":"string"},"AR_EG":{"type":"string"},"RU_RU":{"type":"string"},"FA_IR":{"type":"string"},"NL_NL":{"type":"string"}},"additionalProperties":false,"description":"Internal name of the room."},"pubName":{"$schema":"http://json-schema.org/draft-04/schema","type":"object","properties":{"DE_DE":{"type":"string"},"EN_US":{"type":"string"},"FR_FR":{"type":"string"},"ES_ES":{"type":"string"},"PT_PT":{"type":"string"},"ZH_CN":{"type":"string"},"UK_UA":{"type":"string"},"AR_EG":{"type":"string"},"RU_RU":{"type":"string"},"FA_IR":{"type":"string"},"NL_NL":{"type":"string"}},"additionalProperties":false,"description":"Public-facing name of the room shown to participants."},"color":{"type":["string","null"],"description":"HTML color code for the room."},"capacity":{"type":["integer","null"],"description":"Maximum occupancy of the room."},"extId":{"type":["string","null"],"description":"Optional external identifier."}},"required":["roomId","mtime","order","name","pubName"]},"description":"Rooms in the organization."},"cursor":{"type":["string","null"],"description":"Pagination cursor for the next page."},"more":{"type":"boolean","description":"Whether there are more rooms to fetch."}},"required":["orgId","rooms","more"]}}}},"400":{"description":"Bad request (e.g., missing or invalid fields)"},"403":{"description":"Forbidden"},"404":{"description":"Organization not found"}}}}}}
```