List news items
Retrieve a paginated list of news articles for one organization or custom object. Exactly one of organizationId or objectId is required: articles live in a corpus keyed by company domain, so they are only readable within the scope of a record you already have.
Request
- Base URLhttps://api.commonroom.io/api/v2
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
Prefixed organization ID (format o_<number>) whose news items to read. Required unless objectId is given.
Prefixed custom object ID (format co_<number>) whose news items to read. Resolves through the object's associated organization, falling back to the object's own domain. Required unless organizationId is given. Using this parameter also requires the objects:read scope.
The maximum number of news items to return per page
Pagination cursor from a previous response
News items have no opt-in columns; every field is always returned. The meta column recordCount can be requested to return the total number of matching news items in meta.recordCount.
Sort field
Sort direction
Structured filter as URL-encoded JSON — see the LightFilterExpression schema for the grammar. Conditions are combined (AND) with the other query parameters. An organizationId or objectId clause inside the filter is hoisted to the corresponding query parameter, so the required scope can be supplied either way.
Filterable fields:
| Field | Filter type | Operators | Description |
|---|---|---|---|
| organizationId | stringFilter | eq | Scope the results to one organization (this or objectId, exactly one — as a filter clause or the query parameter). Use organization IDs from GET /organizations (format o_<number>). |
| objectId | stringFilter | eq | Scope the results to the organization associated with one custom object, falling back to the object's own domain (this or organizationId, exactly one). Use object IDs from GET /objects (format co_<number>). |
| newsKeyword | stringListFilter | any, all, none | Free-text search over the article title and body. Operator none excludes the matching articles. Applies a workspace-configured recency window (roughly the last 28 days by default) that a newsPublishedAt clause cannot widen — use newsCategory with newsPublishedAt to search further back. |
| newsCategory | stringListFilter | any, none | Filter news items by category. Values include: hires, promotes, leaves, acquires, merges_with, launches, receives_financing, partners_with, expands_offices_to, and more. |
| newsPublishedAt | dateRangeFilter | in, between, after, before | Filter news items by publication date. |
Groups don't accept a target: send null for target, objectConfigId and targetAssocPaths. Scope news items with organizationId or objectId instead; any target returns a 400.
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.