API Reference

Schema Endpoint

Discover all available field types, filter types, and configuration options.

Schema Endpoint

Get the API schema

GET /api/v1/schema

No authentication required. Returns the complete schema for all configurable types.

Response structure

{
  "fieldTypes": { },
  "filterTypes": { },
  "orderByTypes": { },
  "mapConfig": { },
  "fieldConfig": { },
  "filterConfig": { },
  "orderByConfig": { },
  "styleRuleConfig": { }
}

fieldTypes

Lists all available field types with their configuration schemas:

  • text: Single line text
  • multiline_text: Long text
  • number: Number (integer or decimal)
  • date: Date/date range
  • image: Image URL
  • single_select: Single select dropdown
  • multi_select: Multi-select tags

filterTypes

Lists all available filter types with compatible field types:

  • text: Free-text search
  • autocomplete: Type-ahead search
  • integer, number, decimal: Numeric filters
  • range: Range slider
  • options: Checkbox/button filter
  • date: Date range picker
  • location: Geocoded proximity filter

orderByTypes

  • entropy: Spatial distribution ordering
  • field: Sort by field value

mapConfig

Full schema for MapConfigDto — all properties you can set when creating or updating a map via the API. Includes display options, theming, marker behavior, filter settings, security, and more.

fieldConfig, filterConfig, orderByConfig

Schemas for individual field, filter, and order-by configurations. Use these to understand what properties each type accepts.

styleRuleConfig

Schema for conditional style rules including conditions, marker styling, line/polygon styling, and template overrides.

Use case

The schema endpoint is designed for:

  • API clients: discover available options before making requests
  • Form builders: dynamically generate configuration forms
  • Validation: verify your configuration matches the expected schema
  • Documentation: always up-to-date reference for all configurable properties

Example

curl -s https://app.mapsemble.com/api/v1/schema | jq '.fieldTypes'