v4

latestOpenAPI 3.1.02026-08-08278476614.0 KB

Get Shared Project Layers

Get all layers for a shared project.

Args: share: Validated ProjectShare from token layer_service: Service for fetching layer data

Returns: List of layers in API format (excludes soft-deleted and parcel-restricted layers)

get/api/v1/share/{share_token}/layers

Path parameters

share_tokenstring required

Response

Successful Response

idstring uuid required

project_idstring uuid required

reference_layer_idstring uuid nullable

reference_layer_idsstring[]

namestring required

descriptionstring nullable

style_configobject required

feature_countinteger required

total_size_bytesinteger required

data_versioninteger

schema_versioninteger

metadata_versioninteger

base_attributesobject required

sandbox_relation_namestring nullable

sandbox_schemastring nullable

Schema holding sandbox_relation_name. None means the legacy public schema; per-project scratch schemas (maia_scratch_<hex>) are recorded here at registration (MAIA-3209).

render_mode'detail_always' | 'agg_at_low_zoom'

display_kind'data' | 'boundary'

Whether the layer is a queryable dataset (data) or a styling-only overlay (boundary). Boundary layers paint on the map but suppress the per-layer table, column manager, and feature-detail panel — there is no per-row data worth surfacing.

has_drawable_geometryboolean nullable

Whether the layer holds geometry the map can draw. False marks a table-only upload; None means unrecorded — every layer created before this field, and every creation path that does not state it. Consumers must treat None as unknown, not as False.

created_atstring date-time nullable required

updated_atstring date-time nullable required

data_restrictedboolean

Share-response-only signal that the layer's geometry is shown while every per-row attribute is withheld (parcel layers on anonymous share links). Always False on authenticated reads; set True solely by the shared-project layer builder. The FE renders a 'data unavailable in the public version' state in place of an empty grid.

viz_withheld_column_keysstring[]

Keys of columns the MVT tile refuses to emit as a classed-visualization column, computed per column by column_withheld_from_viz and stamped by to_authenticated_api_format. The picker subtracts these so it offers exactly what the tile will paint; re-deriving the rule client-side from a whole-layer flag over-counts and hides ordinary columns. Empty on share responses, which render no picker.

title_templatestring[]

Ordered column keys the FE concatenates to compose a feature's title (e.g. [parcelnumb], [primary_address_full]). Sourced from the layer's LayerKind, empty for permissive kinds — the FE keeps its generic title fallback for the long tail.

address_templatestring[]

Ordered column keys the FE concatenates to compose a feature's address line. Sourced from the layer's LayerKind; may reference keys that aren't typed canonical columns (city, state_abbr, …). Empty for permissive kinds.