List your permanent links

GET

/rooms/custom

const url = 'https://collab.work.optidata.cloud/api/rooms/custom';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://collab.work.optidata.cloud/api/rooms/custom \
  --header 'Authorization: Bearer <token>'

The rooms you own that have a permanent link (custom_hash), newest first. Only the 5 most recent are returned.

Authorizations

bearerAuth

Responses

200

Up to five rooms with a permanent link.

application/json

Array<object>

<= 5 items

object

required

Internal id. Address the room by hash or custom_hash, never by this id.

integer

room_settings_id

integer | null

cuid

Your company’s id.

string

name

required

string | null

description

string | null

icon_url

string | null

hash

required

The room’s identifier and link.

string

custom_hash

The permanent-link identifier, when the room has one.

string | null

owner_uuid

The user who created the room.

string | null format: uuid

conference_type

on_site for rooms holding an uploaded in-person meeting; null or virtual for video meetings.

string | null

Allowed values: virtual on_site

is_recording_in_progress

boolean

is_ai_notes_enabled

Whether AI meeting notes are on for this room.

boolean

is_ai_notes_locked

Whether participants are prevented from turning AI notes off.

boolean

is_hidden

boolean

chat_uuid

string | null

usage_url

required

The room’s link, to share with participants.

string format: uri

created_at

string format: date-time

updated_at

string format: date-time

deleted_at

string | null format: date-time

settings

object

integer

room_id

integer

max_users

Maximum number of people in the room at once.

integer | null

is_guests_allowed

Whether people without an Optiwork account may join.

boolean

join_mode

Who may enter the room and whether they must ask first:

automatic — anyone with the link enters straight away; guests without an account appear as “Guest”.
no_request — anyone with the link enters without asking; guests type their name first.
unauthenticated_must_request — signed-in Optiwork users enter; guests type their name and ask to join.
authenticated_only_no_request — only signed-in Optiwork users, without asking; guests are turned away.
authenticated_only_must_request — only signed-in Optiwork users, and they ask to join; guests are turned away.
any_must_request — everyone asks to join; guests type their name first.

string

Allowed values: automatic no_request unauthenticated_must_request authenticated_only_no_request authenticated_only_must_request any_must_request

created_at

string format: date-time

updated_at

string format: date-time

participations

Present on getRoom and listRooms.

Array<object>

One person’s presence in a room.

object

integer

room_id

integer

user_id

null for guests without an Optiwork account.

integer | null

role

admin for the room owner, moderator for co-hosts, guest for everyone else.

string | null

Allowed values: admin moderator guest

is_send_audio_allowed

boolean

is_send_video_allowed

boolean

is_send_chat_allowed

boolean

is_guest

boolean

guest_user

Details a guest gave when joining.

object

name

string | null

email

Where the guest gets the meeting summary. Shown only on your own participation, or to the room’s owner, its moderators and company super-administrators.

string | null format: email

should_receive_call_summary

boolean

join_request_status

State of the person’s request to join, in rooms where joining must be requested.

string | null

origin_hash

string | null

is_ai_notes_enabled

boolean

last_active_at

string | null format: date-time

created_at

string format: date-time

updated_at

string format: date-time

deleted_at

string | null format: date-time

user

object

integer

uuid

string format: uuid

cuid

string

username

string

email

string format: email

name

string

company_name

string | null

status

string

avatar_url

string | null

settings

The user’s display preferences (language, theme, time zone).

object | null

created_at

string format: date-time

updated_at

string format: date-time

deleted_at

string | null format: date-time

last_recording

One of:

object
null

object

required

integer

room_id

required

integer

user_id

The person who made the recording.

integer | null

name

string | null

status

required

creating, started — being recorded.
stopped_locally, pending, processing — recorded; being saved and processed.
stopped — done; the transcript follows when ready.
failed — interrupted; see startRecordingRecovery.

string

Allowed values: creating started pending processing stopped_locally stopped failed

type

required

manual when a participant pressed record; automatic for the audio recorded to produce AI meeting notes; audio_only_sibling for the audio track kept next to a manual recording.

string

Allowed values: manual automatic audio_only_sibling

duration_ms

integer | null

chunks_count

integer | null

is_drive_saved

Whether a copy was saved to Optiwork Drive.

boolean

sibling_recording_id

integer | null

is_processing

boolean

is_in_progress

boolean

public_link_url

The public link, when the recording has one.

string | null

link

Address of the recording page in Optiwork.

string

meta

Technical details of the recording. Its content may change; do not rely on it.

object | null

created_at

string format: date-time

updated_at

string format: date-time

stopped_at

string | null format: date-time

room

object recursive

user

object

integer

uuid

string format: uuid

cuid

string

username

string

email

string format: email

name

string

company_name

string | null

status

string

avatar_url

string | null

settings

The user’s display preferences (language, theme, time zone).

object | null

created_at

string format: date-time

updated_at

string format: date-time

deleted_at

string | null format: date-time

participations

Who was in the meeting while it was recorded.

Array<object>

One person’s presence in a room.

object

integer

room_id

integer

user_id

null for guests without an Optiwork account.

integer | null

role

admin for the room owner, moderator for co-hosts, guest for everyone else.

string | null

Allowed values: admin moderator guest

is_send_audio_allowed

boolean

is_send_video_allowed

boolean

is_send_chat_allowed

boolean

is_guest

boolean

guest_user

Details a guest gave when joining.

object

name

string | null

email

Where the guest gets the meeting summary. Shown only on your own participation, or to the room’s owner, its moderators and company super-administrators.

string | null format: email

should_receive_call_summary

boolean

join_request_status

State of the person’s request to join, in rooms where joining must be requested.

string | null

origin_hash

string | null

is_ai_notes_enabled

boolean

last_active_at

string | null format: date-time

created_at

string format: date-time

updated_at

string format: date-time

deleted_at

string | null format: date-time

user

object

integer

uuid

string format: uuid

cuid

string

username

string

email

string format: email

name

string

company_name

string | null

status

string

avatar_url

string | null

settings

The user’s display preferences (language, theme, time zone).

object | null

created_at

string format: date-time

updated_at

string format: date-time

deleted_at

string | null format: date-time

permissions

People and groups the recording is shared with.

Array<object>

object

key

additional properties

any

link_permission

The public-link setting, when the recording has a public link.

object | null

transcription

One of:

object
null

object

integer

recording_id

integer

status

string

Allowed values: queued processing completed error

summary

AI summary of the meeting.

string | null

key_points

AI key points, as a JSON-encoded string: an array of { "title", "items": [string] } sections.

string | null

content

The full transcript as produced by the speech-to-text engine (utterances, words, speakers, timings). Its exact shape depends on the engine and may change.

object | null

transcript_id

string | null

transcript_error

string | null

meta

object | null

created_at

string format: date-time

updated_at

string format: date-time

Examples

rooms

[
  {
    "id": 12226,
    "room_settings_id": 12220,
    "cuid": "7f3c2a10-5b8e-4d21-9c6a-0e4f1b2d3c4a",
    "name": "Weekly sync",
    "description": "Product team weekly meeting.",
    "icon_url": "https://collab.work.optidata.cloud/images/pages/bs-icon-camera-video.svg",
    "created_at": "2026-10-19T14:40:53.000000Z",
    "updated_at": "2026-10-19T14:40:53.000000Z",
    "deleted_at": null,
    "hash": "a3050cd3-5921-4153-b90a-owt42-e94de63c7b15",
    "is_recording_in_progress": false,
    "chat_uuid": null,
    "owner_uuid": "2d9e8f70-1a3b-4c5d-8e9f-a0b1c2d3e4f5",
    "custom_hash": "owt42-acme-weekly-sync",
    "is_hidden": false,
    "conference_type": null,
    "is_ai_notes_enabled": false,
    "is_ai_notes_locked": false,
    "usage_url": "https://collab.work.optidata.cloud/rooms/a3050cd3-5921-4153-b90a-owt42-e94de63c7b15"
  }
]

401

No authentication key was sent, or it is malformed.

application/json

Authentication failures use an error key rather than message.

object

error

required

string

Examples

missing

No bearer token sent

{
  "error": "JWT passport exception: Missing bearer token in request"
}

419

The authentication key is expired or not recognised. Get a fresh one and retry.

application/json

Authentication failures use an error key rather than message.

object

error

required

string

Examples

expired

{
  "error": "JWT passport expired: Passport expired"
}