Skip to main content
GET
cURL

Query Parameters

access_scope
string

Use 'home' to include direct, organization, and public-access assets.

collection_id
string
cursor
string

Opaque cursor from a previous page response.

limit
integer

Max assets to return. Default 100, max 1000.

locked
boolean
metadata
string[]

Metadata filter as key:value (containment) or bare key (existence). Repeatable; AND logic.

ordering
string

Ignored by cursor pagination. Results are always ordered by -is_starred, -created_at, id.

owner_id
string
owner_type
string
q
string

Case-insensitive substring filter on asset title or alias.

record_type
string

Asset type enum value. Comma-separated values use OR logic.

tags
string

Comma-separated tags to filter by

title
string[]

Exact asset title filter. Repeatable; OR logic.

title_prefix
string

Case-insensitive asset-title prefix filter.

Response

200 - application/json
id
string<uuid>
required
read-only
title
string
required
Maximum string length: 255
owner_type
string
required
read-only
owner_id
string<uuid>
required
read-only
owner_name
string | null
required
read-only
creator_id
string<uuid>
required
read-only
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
current_content
object | null
required
creator_name
string | null
required
read-only
effective_flags
integer
required
read-only
preferred_repository_id
string<uuid> | null
required
read-only
is_migrating
boolean
required
read-only
is_starred
boolean
required
read-only
authors
object[]
required
read-only
image_url
string | null
required
read-only
did
string
required
read-only
access_scope
string
required
read-only
description
string
alias
string
Maximum string length: 255
record_type
enum<string>
  • dataset - Dataset
  • sample_specimen - Sample / Specimen
  • synthesis - Synthesis
  • fabrication - Fabrication
  • processing - Processing
  • assembly - Assembly
  • measurement - Measurement
  • imaging - Imaging
  • spectroscopy - Spectroscopy
  • diffraction_scattering - Diffraction / Scattering
  • mechanical_testing - Mechanical Testing
  • thermal_analysis - Thermal Analysis
  • electrical_testing - Electrical Testing
  • chemical_assay - Chemical Assay
  • biological_assay - Biological Assay
  • environmental_observation - Environmental Observation
  • calibration - Calibration
  • quality_control - Quality Control
  • simulation - Simulation
  • analysis - Analysis
  • protocol_workflow - Protocol / Workflow
  • software_code - Software / Code
Available options:
dataset,
sample_specimen,
synthesis,
fabrication,
processing,
assembly,
measurement,
imaging,
spectroscopy,
diffraction_scattering,
mechanical_testing,
thermal_analysis,
electrical_testing,
chemical_assay,
biological_assay,
environmental_observation,
calibration,
quality_control,
simulation,
analysis,
protocol_workflow,
software_code
tags
string[]
Maximum string length: 100
metadata
any
is_locked
boolean
provenance_token
string | null
read-only
cited_work
object

An OpenAlex Work shaped for the sidebar citation exporter.

authors / venue / biblio are read off the stored OpenAlex metadata payload — the same extraction beta's unified works search uses for its result rows (works_search_views._authors_from_work_dict / _venue_from_work_dict) — so rendering one linked work needs NO WorkAuthor / Person / Source joins. Read-only; Works are ingested data.

Defined above AssetSerializer so its cited_work field can reference this class in @extend_schema_field (which also registers the component).