List feed post rows
Módulo Workforce
GET/feed-postsfeedPosts.list
A feed post for an audience: an announcement, update, poll or recognition, with pinning, required acknowledgment, reaction and comment switches and a publish time. Returns a cursor page of feed post rows the caller may see. The default order is `publish_at` descending, newest first. Supports sparse fieldsets and the filter grammar.
- Requiere la capacidad knowledge.sop.read.
- Alcances de OAuth: knowledge.
- 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
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| limit | Limit | No | Page size. Default 50, maximum 200.Restricciones: range 1 to 200 |
| cursor | Cursor | No | Opaque cursor from `next_cursor` of the previous page.Restricciones: length 1 to any |
| fields | Fields | No | Sparse 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_]*)*$ |
| sort | Sort | No | Sort 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_]*)*$ |
| filter | Filter | No | Filter 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 FeedPost
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the feed post. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Person who created the row; null for seed, platform or system writes. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Person who last updated the row; null for seed, platform or system writes. |
| post_kind | "Announcement" | "Update" | "Poll" | "Recognition" | Sí | Post kind; Poll posts come from the createPoll action, Recognition posts from recognitions. |
| title | string | null | Sí | Optional headline.Restricciones: length 1 to 200 |
| body | string | Sí | Post text.Restricciones: length 1 to 10000 |
| audience_kind | "Organization" | "Project" | "Team" | "Department" | "Role" | "Group" | Sí | Who the row reaches. Department (a canon department, 1365) is for feed posts only. |
| project_id | string (uuid) | null | Sí | Identifier of the project audience, or the project the row belongs to. |
| team_id | string (uuid) | null | Sí | Identifier of the team audience. |
| role_id | string (uuid) | null | Sí | Identifier of the org role audience. |
| group_id | string (uuid) | null | Sí | Identifier of the group audience, including department groups. |
| department_code | string | null | Sí | Canon department code of a Department audience (xpms.dim_department).Restricciones: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$ |
| author_membership_id | string (uuid) | null | Sí | Identifier of the member who wrote the post. |
| pinned_at | string (date-time) | null | Sí | When the post was pinned; null when not pinned. |
| requires_acknowledgment | boolean | Sí | Whether every member of the audience must acknowledge it. |
| reactions_enabled | boolean | Sí | Whether members can react. |
| comments_enabled | boolean | Sí | Whether members can comment. |
| publish_at | string (date-time) | Sí | When the post appears; a future time schedules it. |
| notified_at | string (date-time) | null | Sí | When the audience was notified. |
| hidden_at | string (date-time) | null | Sí | When the post was hidden. |
| hidden_reason | string | null | Sí | Why it was hidden.Restricciones: length 1 to 500 |
{
"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",
"post_kind": "Announcement",
"title": "Wristband change",
"body": "Wristbands change color on Friday.",
"audience_kind": "Organization",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"team_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"role_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"group_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"department_code": "5000",
"author_membership_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"pinned_at": "2026-10-08T14:30:00Z",
"requires_acknowledgment": false,
"reactions_enabled": true,
"comments_enabled": true,
"publish_at": "2026-10-08T14:30:00Z",
"notified_at": "2026-10-08T14:30:00Z",
"hidden_at": "2026-10-08T14:30:00Z",
"hidden_reason": "Posted to the wrong project."
}
],
"next_cursor": null
}Ejemplos de código
curl -X GET "$XOS_BASE_URL/feed-posts" \
-H "Authorization: Bearer $XOS_API_KEY"for await (const row of xos.feedPosts.listAll()) {
console.log(row);
}for row in xos.feed_posts.list_all():
print(row)xos feed-posts list --all