Skip to content

Commit 47651e7

Browse files
Copilothotlong
andcommitted
docs: update api-reference to use canonical filter (not $filter) and document GET-by-ID allowed params
Co-authored-by: hotlong <50353452+hotlong@users.noreply.github.com>
1 parent 92fc058 commit 47651e7

1 file changed

Lines changed: 17 additions & 6 deletions

File tree

content/docs/guides/api-reference.mdx

Lines changed: 17 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -139,11 +139,15 @@ Query records with filtering, sorting, selection, and pagination.
139139
| Parameter | Location | Description |
140140
|:----------|:---------|:------------|
141141
| `object` | path | Object name |
142-
| `$select` | query | Comma-separated field names |
143-
| `$filter` | query | Filter expression (OData-style or JSON) |
144-
| `$orderby` | query | Sort expression (e.g. `-created_at`) |
145-
| `$top` | query | Limit (default: 20) |
146-
| `$skip` | query | Offset |
142+
| `select` | query | Comma-separated field names |
143+
| `filter` | query | Filter expression (JSON). `filters` also accepted for backward compatibility. |
144+
| `sort` | query | Sort expression (e.g. `name asc` or `-created_at`) |
145+
| `top` | query | Limit (default: 20) |
146+
| `skip` | query | Offset |
147+
| `expand` | query | Comma-separated list of relations to eager-load |
148+
| `search` | query | Full-text search query |
149+
150+
> **Note:** OData-style `$`-prefixed parameters (`$filter`, `$select`, `$orderby`, `$top`, `$skip`) are supported via the [OData endpoint](/docs/references/api/odata). The standard REST API uses unprefixed parameter names.
147151
148152
**Response**:
149153
```json
@@ -157,7 +161,14 @@ Query records with filtering, sorting, selection, and pagination.
157161

158162
### `GET /data/:object/:id`
159163

160-
Get a single record by ID.
164+
Get a single record by ID. Only `select` and `expand` query parameters are allowed; all other parameters are discarded.
165+
166+
| Parameter | Location | Description |
167+
|:----------|:---------|:------------|
168+
| `object` | path | Object name |
169+
| `id` | path | Record ID |
170+
| `select` | query | Comma-separated field names to include |
171+
| `expand` | query | Comma-separated list of relations to eager-load |
161172

162173
**Response**: `{ object: "account", id: "1", record: { ... } }`
163174

0 commit comments

Comments
 (0)