Query object records

POST/api/objects/query

Returns object records that match the provided query, filters, and sort rules.

Request Body

application/json

Request payload for Query object records.

objectId*string

Object definition identifier to query.

Example"objdef_123"

query?|

Free-text query applied to object records.

titleColumn?|

Field used as the display title in responses.

filters?array<>|

Structured object filters.

onlyFavorites?|

When true, restricts custom object records to favorites for the current workspace user.

Exampletrue

includeComputedFields?|

When false, skips server-computed enrichment fields that are not needed for auxiliary reads.

Examplefalse

limit?|||||

Maximum number of results to return.

offset?|||||

Number of results to skip before returning data.

orderBy?array<>|

Sort rules for the query.

includeTotal?|

When true, include the total matching record count.

facets?array<>|

Facet fields to compute from the same filtered result set.

[key: string]?never

Response Body

`application/json`

curl -X POST "https://loading/api/objects/query" \  -H "Content-Type: application/json" \  -d '{    "objectId": "objdef_123"  }'

{
  "records": [
    {
      "id": "objrec_123",
      "data": {
        "name": "Acme",
        "stage": "lead"
      },
      "handle": "projects",
      "createdAt": "2026-03-10T12:00:00.000Z",
      "updatedAt": "2026-03-10T12:05:00.000Z",
      "workspaceId": "ws_123",
      "customObjectDefinitionId": "objdef_123",
      "externalId": "crm_9981"
    }
  ],
  "limit": 0,
  "offset": 0,
  "nextOffset": 0,
  "hasMore": true,
  "totalCount": 0,
  "facets": {
    "property1": [
      {
        "label": "string",
        "value": "string",
        "count": 0
      }
    ],
    "property2": [
      {
        "label": "string",
        "value": "string",
        "count": 0
      }
    ]
  }
}

{
  "_tag": "ApiBadRequestError",
  "code": "PRICE_IMPORT_DUPLICATE_SKUS",
  "message": "The request payload is invalid.",
  "description": "Remove duplicate SKU rows before importing the file.",
  "details": {}
}

{
  "_tag": "Unauthorized"
}

{
  "_tag": "ApiForbiddenError",
  "message": "You do not have permission to perform this action."
}

{
  "_tag": "ApiNotFoundError",
  "message": "The requested resource was not found."
}

{
  "_tag": "ApiConflictError",
  "message": "A resource with this handle already exists."
}

{
  "_tag": "ApiUnprocessableEntityError",
  "message": "The order cannot be submitted without items."
}

{
  "_tag": "ServiceUnavailable"
}

{
  "_tag": "ApiTimeoutError",
  "message": "The upstream operation timed out."
}

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

503application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`