Nurama Developers
Chats

Get a paginated list of member chats the user has created or is part of.

GET
/chats/member

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: chat:read

Query Parameters

paginate?string

Pagination type to use

Default"index"

Value in

  • "cursor"
  • "index"
updatedBefore?string

Get chats updated before this timestamp (only for index pagination). Unix time in milliseconds; a value that looks like seconds is rejected with a 400 validationError.

Formatdate-time
sort?

Sorting criteria for chats based on creation or update times.

Default

{  "updatedAt": -1}
limit?integer

Limit the number of chats returned.

Rangevalue <= 20
Default20
recentMessages?integer

Limit the number of recent messages returned for each chat.

Rangevalue <= 20
Default20
scopeId?string

Only return member chats belonging to this scope (workspace or project).

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
subjectSearch?string

Search term to filter chats by subject (partial match, case-insensitive).

Lengthlength <= 100
memberSearch?string

Member ID to filter chats by specific member participation.

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
archived?boolean

Archive filter for the current user. true returns only chats the user has archived, false returns only chats the user has not archived. Omit to return both.

page?integer

Page number for index pagination.

Default1
cursor?string

Cursor for pagination (only for cursor pagination)

paginateReverse?boolean

If true, paginates in reverse order (only for cursor pagination)

Defaultfalse
includeCounts?boolean

If true, includes count information (only for cursor pagination)

Defaultfalse
includeCursorRecord?boolean

Include cursor record in results (only for cursor pagination)

Defaultfalse
startAt?string

ID of the record to start pagination from (only for cursor pagination)

includeStartAtRecord?boolean

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

Defaulttrue

Response Body

application/json

curl -X GET "https://example.com/chats/member"
{  "page": 0,  "limit": 0,  "totalPages": 0,  "totalResults": 0,  "queryAt": 0,  "results": [    {      "scopeId": "65fafe40-a220-4dd7-8724-4598b81c0643",      "scopeType": "project",      "scope": {        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",        "name": "string",        "slug": "string",        "logo": "3c06f846-1ab1-40a9-8645-a19a9fdeae85"      },      "subject": "string",      "icon": "bc9b3dc5-578a-4929-a13c-7d1a9725e2b0",      "members": [        "15b1f20b-98d8-4c50-b89a-13711baf259b"      ],      "participants": [        "e3139958-26f5-4fd4-a9c9-fe1c29c5cbac"      ],      "totalMessages": 0,      "recentMessages": [        "6738c803-41a8-4296-a5bd-8d9974ec6fa0"      ],      "status": "active",      "createdBefore": 0,      "createdAt": 1678886400000,      "updatedAt": 1678886400000    }  ]}