Saltar al contenido

List comment thread rows

Módulo Platform

GET/comment-threadscommentThreads.list

A comment thread on any record. Returns a cursor page of comment thread rows the caller may see. The default order is `created_at` ascending. Supports sparse fieldsets and the filter grammar.

  • Requiere la capacidad work.record.read.
  • Alcances de OAuth: work.
  • Paginación por cursor: se aplican limit, cursor, fields, sort y filter.
  • Estados de error: 400, 401, 429. Los errores son detalles de problema RFC 9457.

Parámetros de ruta y de consulta

commentThreads.list: Parámetros de ruta y de consulta
CampoTipoObligatorioDescripción
limitLimitNoPage size. Default 50, maximum 200.Restricciones: range 1 to 200
cursorCursorNoOpaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any
fieldsFieldsNoSparse fieldset: a comma-separated list of top-level fields to return. `id` is always returned.Restricciones: pattern ^[a-z_][a-z0-9_]*(,[a-z_][a-z0-9_]*)*$
sortSortNoSort keys, comma-separated; a leading `-` sorts descending. Without `sort`, the documented default order applies (coded lists sort in numeric code order).Restricciones: pattern ^-?[a-z_][a-z0-9_]*(,-?[a-z_][a-z0-9_]*)*$
filterFilterNoFilter grammar `filter[field][op]=value`. Operators: eq, ne, lt, lte, gt, gte, in (comma-separated values), is_null (true or false) and contains. Conditions combine with AND.

Respuesta 200: una página de CommentThread

commentThreads.list: CommentThread
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the comment thread.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
subject_tablestringSíTable of the subject, one of app.comment_subjects.Restricciones: pattern ^[a-z][a-z0-9_]*$
subject_idstring (uuid)SíIdentifier of the row the thread is about.
anchorstring | nullSíPart of the subject the thread is anchored to; null for the main thread.Restricciones: length 1 to 300
resolved_atstring (date-time) | nullSíWhen the thread was resolved; null while open.
resolved_bystring (uuid) | nullSíIdentifier of the person who resolved it, set from the session.
{
  "data": [
    {
      "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "created_at": "2026-10-08T14:30:00Z",
      "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "updated_at": "2026-10-08T14:30:00Z",
      "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "subject_table": "records",
      "subject_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
      "anchor": "line:12",
      "resolved_at": "2026-10-08T14:30:00Z",
      "resolved_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f"
    }
  ],
  "next_cursor": null
}

Ejemplos de código

curl -X GET "$XOS_BASE_URL/comment-threads" \
  -H "Authorization: Bearer $XOS_API_KEY"
for await (const row of xos.commentThreads.listAll()) {
  console.log(row);
}
for row in xos.comment_threads.list_all():
    print(row)
xos comment-threads list --all