List custom objects
Retrieve a paginated list of custom objects.
Request
- Base URLhttps://api.commonroom.io/api/v2
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
The maximum number of objects to return per page
Pagination cursor from a previous response
Field to sort results by
Sort direction
Filter objects by prefixed object type ID (format cot_<number>)
Filter objects by prefixed segment ID (format s_<number>)
Comma-separated list of additional columns to include in the response. Valid column values: recordKey, tags, url. Use cf_* to include all custom fields, or cf_<id> for a specific one. The meta column recordCount can be requested to return the total number of matching objects in meta.recordCount.
Structured filter as URL-encoded JSON — see the LightFilterExpression schema for the grammar. Conditions are combined (AND) with the other query parameters.
Filterable fields:
| Field | Filter type | Operators | Description |
|---|---|---|---|
| objectSegmentId | stringListFilter | any, all, none | Filter objects by segment membership. Use segment IDs from GET /segments. |
| objectLabelId | stringListFilter | any, all, none | Filter objects by tag. Use tag IDs from GET /tags. |
| objectRecordKey | stringListFilter | any, all, none | Filter objects by record keys |
| objectName | stringFilter | eq, like | Filter objects by name |
| objectLeadScorePercentile | leadScoreFilter | eq, ne, gt, gte, lt, lte | Filter objects by lead score percentile (0-100). Requires a scoreId from GET /lead-scores. |
| ls_* | numberFilter | eq, ne, gt, gte, lt, lte | Filter objects by a Point Value lead score's raw point total, using the score ID as the field name. May be negative or fractional. Only scores whose outputType is point_value match; use objectLeadScorePercentile for percentile scores. |
| cf_* | stringFilter | varies by field type | Filter by custom field value. Use the custom field ID (e.g., "cf_123456") as the field name. Find field IDs and their types via GET /custom-fields. Supports stringFilter for text fields, stringListFilter for enum/dropdown fields, numberFilter for numeric fields, booleanFilter for checkbox fields, and dateRangeFilter for date fields. |
Filtering by a related entity: a group whose target names another entity applies its clauses to that entity, using the fields of that entity's list endpoint. Every group must send target, objectConfigId and targetAssocPaths, using null for any it doesn't use. Targets this endpoint accepts:
| Target | Matches custom objects | Clauses use |
|---|---|---|
| Object | associated with a matching custom object; set objectConfigId to its type (cot_<id>), even when it is the listed type | GET /objects fields |
| Contact (alias Member) | associated with a matching contact | GET /contacts fields |
| Organization (alias Company) | associated with a matching organization | GET /organizations fields |
Any other target returns a 400.
Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.