Sign in
layer

Get Project Layers

Get all layers for a specific project.

Args: project_id: The ID of the project to get layers for (validated for read access) layer_service: Service for handling layer operations

get/api/v1/layer/{project_id}

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
running_source_table'parcel' | 'building' | 'place' | 'address' | 'school'

The table a resolved feature lives in — what a caller pulls its data from, and the feature's kind. A text match in the address, place or school table resolves (point-in-feature) to a parcel/building; a parcel attribute match resolves to the parcel itself.

remaining_feature_capacityinteger nullable

Features that authenticated add flows can still append before the server-enforced per-layer limit.

feature_capacityinteger nullable

Server-enforced maximum feature count for this layer.

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.

Changes

Changed in 5 of the 30 revisions of this API.34

  • 7720763f8bf11See the full diff
    • ●

      added the new duration enum value to the ///// response property for the response status

      response-property-enum-value-added

    This revision also has 13 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • d0e2bf840dfc1See the full diff
    • ●

      added the new future_land_use enum value to the ///// response property for the response status

      response-property-enum-value-added

  • 0c94a4b5a00e3See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • ac8a0a8837e31See the full diff
    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

  • ba2b8d9621611See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog