Common Filters
These filters are available on most list endpoints:| Parameter | Type | Description |
|---|---|---|
created_after | datetime | Only records created after this timestamp (ISO 8601) |
created_before | datetime | Only records created before this timestamp (ISO 8601) |
Resource-Specific Filters
Jobs
| Parameter | Type | Description |
|---|---|---|
project_id | string | Jobs in this project |
status | string | Filter by status: Queued, Started, Completed, Failed, Canceled |
type | string | Filter by job type (e.g., compare) |
target_type | string | Filter by target resource type: drawing, sheet, block, overlay |
target_id | string | Filter by target resource ID |
parent_id | string | Child jobs of a parent job |
Drawings
| Parameter | Type | Description |
|---|---|---|
project_id | string | Required. Drawings in this project |
name | string | Filter by name (case-insensitive substring match) |
Sheets
| Parameter | Type | Description |
|---|---|---|
drawing_id | string | Sheets in this drawing |
project_id | string | Sheets across all drawings in a project |
discipline | string | Filter by discipline (e.g., architectural, structural) |
sheet_number | string | Exact match on sheet number (e.g., A-101) |
Blocks
| Parameter | Type | Description |
|---|---|---|
sheet_id | string | Blocks on this sheet |
type | string | Filter by block type (e.g., Plan, Detail, Schedule) |
Overlays
| Parameter | Type | Description |
|---|---|---|
project_id | string | Overlays in this project |
job_id | string | Overlays created by a specific comparison job |
drawing_id | string | Overlays involving blocks from this drawing |
has_changes | boolean | Only overlays where change detection has been run (true) or not (false) |
Files
| Parameter | Type | Description |
|---|---|---|
project_id | string | Required. Files in this project |
content_type | string | Filter by MIME type (e.g., application/pdf) |