Explorer query

POST /admin/explorer/query

Execute a structured explorer query against an entity. Supports simple field filters (eq, neq, contains, gt, lt, gte, lte, isNull, isNotNull), aggregate relation filters with functions (count, avg, sum, min, max), and cross-entity fields that resolve to joins: documents.creatorRole (creator's project role), documents.organizationType (org consultant type), documents.consultantName (review section disciplines — use "contains" operator), projects.gcContactCount (contacts with GC role), projects.consultantCount (consultant groups), organizations.avgReviewDays (mean days from submittal creation to closure). Aggregate example: {type:"aggregate", relation:"documents", function:"max", field:"createdAt", operator:"gt", value:"2026-01-01"} finds projects whose most recent document was created after Jan 2026. Returns paginated rows, column metadata, total count, and validation warnings.

Authorization

bearer

AuthorizationBearer <token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

entity*string

Entity to query

Value in"projects" | "documents" | "organizations" | "users"

filters?array<>

Array of filter objects. Simple: {field, operator, value}. Aggregate: {type:"aggregate", relation, function?, field?, subFilters:[...], operator, value}. function defaults to "count". For min/max/avg/sum, field is required and must support the function.

sortBy?string

Field key to sort by (default: createdAt)

sortOrder?string

Sort direction (default: desc)

Value in"asc" | "desc"

limit?number

Page size (1-200, default: 50)

cursor?string

Pagination cursor (uid of last row)

Response Body

curl -X POST "https://api.part3.io/v1/admin/explorer/query" \  -H "Content-Type: application/json" \  -d '{    "entity": "projects"  }'

Empty