Nurama Developers
Convos

Get convos for a project scope (paginated)

Returns convos across all chats in a project, filtered to the requested chat visibilities. The caller must hold the chat-read permission for **every** requested visibility (`canGetCreatorChat` / `canGetReviewerChat`). Active convos are listed first, then newest first. `search` matches participant names and convo type and is applied to the current page after the query.

GET
/convos/scope/{scopeId}

Returns convos across all chats in a project, filtered to the requested chat visibilities. The caller must hold the chat-read permission for every requested visibility (canGetCreatorChat / canGetReviewerChat). Active convos are listed first, then newest first. search matches participant names and convo type and is applied to the current page after the query.

Authorization

AuthorizationBearer <token>

OAuth 2.1 authorization code flow with PKCE (required of every client, public or confidential). Scopes are a ceiling on the credential, not a grant of access: a token also cannot exceed what the user who approved it may already do. A write scope does not imply its matching read — ask for both.

In: header

Scope: convos:read

Path Parameters

scopeId*string

Project ID

Match^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Formatuuid

Query Parameters

visibility*array<>

Chat visibilities to include (e.g. visibility[]=creator&visibility[]=reviewer)

Items1 <= items
status?string

Filter convos by status

Value in

  • "active"
  • "completed"
  • "cancelled"
search?string

Case-insensitive match against participant names and convo type (current page only)

paginate?string

Pagination type

Default"cursor"

Value in

  • "cursor"
  • "index"
limit?integer

Results per page

Rangevalue <= 100
Default20
cursor?string

Cursor for pagination (only for cursor pagination)

paginateReverse?boolean

Paginate in reverse order (only for cursor pagination)

includeCounts?boolean

Include total counts (only for cursor pagination)

includeCursorRecord?boolean

Include the cursor record in the results (only for cursor pagination)

startAt?integer

Record to start pagination from (only for cursor pagination)

includeStartAtRecord?boolean

Include the startAt record in the results (only for cursor pagination)

page?integer

Page number (only for index pagination)

Response Body

application/json

curl -X GET "https://example.com/convos/scope/497f6eca-6276-4993-bfeb-53cbbbba6f08?visibility=creator"
{  "nextCursor": "string",  "prevCursor": "string",  "hasNextPage": true,  "hasPrevPage": true,  "totalResults": 0,  "totalPreviousResults": 0,  "totalNextResults": 0,  "queryAt": 0,  "results": [    {      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",      "convoType": "video",      "status": "active",      "subject": "string",      "notes": "string",      "chatId": "f255124e-3419-4f6e-b7ee-17a6577db94d",      "chat": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "chatType": "topic",        "topicId": "97b608a9-302e-4387-a5f4-fd35969cdc21",        "topicType": "asset",        "replyType": "quote",        "subject": "string",        "visibility": "creator",        "publicId": "f72dfe8e-6cfd-43c2-b1cb-95adbf313789",        "participants": [          "e3139958-26f5-4fd4-a9c9-fe1c29c5cbac"        ],        "following": [          "6bc36f94-42f8-4778-8086-0f778a9e5f30"        ],        "annotations": [          {}        ],        "totalMessages": 0,        "lastMessageAt": "2019-08-24T14:15:22Z",        "recentMessages": [          "6738c803-41a8-4296-a5bd-8d9974ec6fa0"        ],        "activeConvoId": "6ac5e0e4-f5db-4276-ac1c-9dd077ad79d2",        "activeConvo": "d97b3779-3421-4076-bf6e-15252c014d1d",        "status": "active",        "createdAt": "2019-08-24T14:15:22Z",        "updatedAt": "2019-08-24T14:15:22Z"      },      "chatType": "chat",      "messageId": "8540d774-4863-4d2b-b788-4ecb19412e85",      "message": "3eb7c4fd-0d67-442a-a08d-929546df1ebe",      "dailyRoomName": "string",      "dailyRoomUrl": "string",      "dailyRoomConfig": {},      "startedById": "7347b630-d3cd-4c11-b046-3f92c23756e5",      "startedBy": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "firstName": "string",        "lastName": "string",        "displayName": "string",        "avatar": "01d8bd6c-6014-46aa-b5b1-14d337c9c779",        "color": "string",        "awards": [          "staff"        ],        "accountType": "standard"      },      "activeParticipants": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "firstName": "string",          "lastName": "string",          "displayName": "string",          "avatar": "01d8bd6c-6014-46aa-b5b1-14d337c9c779",          "color": "string",          "awards": [            "staff"          ],          "accountType": "standard"        }      ],      "allParticipants": [        {          "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",          "firstName": "string",          "lastName": "string",          "displayName": "string",          "avatar": "01d8bd6c-6014-46aa-b5b1-14d337c9c779",          "color": "string",          "awards": [            "staff"          ],          "accountType": "standard"        }      ],      "startedAt": 0,      "endedAt": 0,      "durationMinutes": 0,      "recordings": [        {}      ],      "transcripts": [        {}      ],      "participantSessions": [        {}      ],      "billedAtVideo": 0,      "billedCreditsVideo": 0,      "billedAtRecording": 0,      "billedCreditsRecording": 0,      "inheritanceId": "09c886ac-e6e5-4263-a494-a6e14f7e4f46",      "scopeId": "65fafe40-a220-4dd7-8724-4598b81c0643",      "scopeType": "project",      "scopeVisibility": [        "creator"      ],      "createdAt": 0,      "updatedAt": 0    }  ]}