Skip to content
Artist Alley

List field definitions (the metadata schema)

GET
/fields

Returns field definitions, ordered by display group and display order. The result is the schema admins build through the field-management UI.

By default, archived (soft-deleted) fields are excluded — the list is the live schema. Pass an explicit status to filter to exactly one status; status=archived surfaces the tombstones for anyone who needs them.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
status
string
Allowed values: active deprecated archived
asset_type
integer format: int64

When set, only fields whose applies_to is empty (=all) or contains this asset_type ref are returned. Used by the asset edit form to figure out which fields to show. Implies subject_kind=asset — collection fields aren’t applies_to-scoped.

subject_kind
string
Allowed values: asset collection

Filter by subject kind. asset returns only asset-side definitions (default behaviour for callers that don’t specify); collection returns only collection-side definitions. Omit to return both kinds.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

List of field definitions

Array<object>
object
id
required
string format: uuid
code
required

Federation-stable slug. Globally unique.

string
label
required
string
description
string
type
required
string
Allowed values: text longtext rich_text number boolean date datetime select multi_select tree reference
subject_kind
required

What the field describes. asset definitions apply to individual assets; collection definitions apply to whole collections. One row is one or the other — operators who want a field on both kinds create two rows.

string
Allowed values: asset collection
options

Type-dependent constraints / values. Shape per ADR 0012.

object
key
additional properties
any
required
required
boolean
searchable
required
boolean
applies_to
required

Resource type refs this field applies to. Empty = all. Ignored when subject_kind = ‘collection’.

Array<integer>
field_set_id
string format: uuid
nullable
read_capability
string
nullable
write_capability
string
nullable
display_order
required
integer
display_group
required
string
source

Auto-extraction source, e.g. {“type”:“exif”,“tag”:“DateTimeOriginal”}.

object
key
additional properties
any
extraction_source

CanonicalField the metadata-extraction pipeline writes into this field. Empty = no extraction (the field stays operator-managed). Edited via the dedicated PUT …/extraction endpoint.

string
extraction_mode

Write behaviour when extraction has a value. Empty = default (skip_if_set).

string
Allowed values: "" skip_if_set replace append prepend
status
required
string
Allowed values: active deprecated archived
deprecated_replacement_id
string format: uuid
nullable
created_at
required
string format: date-time
updated_at
required
string format: date-time

401

Section titled “401 ”

Authentication required, missing, or invalid

object
error
required

Human-readable error summary

string
Example
the request could not be completed
Example
{
  "error": "authentication required: sign in and retry with a valid session or API token"
}

500

Section titled “500 ”

Unexpected server error

object
error
required

Human-readable error summary

string
Example
the request could not be completed