← Back to Client

Schema Documentation

Your civic data must conform to these schemas. Start with the full Civic Data schema, which includes all entity types.

Civic Data

Complete civic data package for a jurisdiction

Required Fields

  • jurisdiction

All Properties

$schema string

Schema URL for validation

agencies array

Government agencies in this jurisdiction

generated_at string

When this data was generated/exported

jurisdiction → jurisdiction required

The primary jurisdiction this data represents

officials array

Elected and appointed officials

services array

Services provided by agencies in this jurisdiction

version string

Schema version (e.g., '1.0')

Example

{
  "$schema": "https://civic.bot/schema/civic-data.schema.json",
  "agencies": [
    {
      "id": "springfield-il-city-clerk",
      "jurisdiction_id": "springfield-il",
      "name": "Office of the City Clerk",
      "phone": "(217) 789-2200",
      "type": "department"
    }
  ],
  "generated_at": "2024-01-15T10:30:00Z",
  "jurisdiction": {
    "id": "springfield-il",
    "name": "City of Springfield",
    "parent_id": "sangamon-county-il",
    "population": 114230,
    "short_name": "Springfield",
    "type": "municipal",
    "website": "https://www.springfield.il.us"
  },
  "officials": [
    {
      "agency_id": "springfield-il-mayors-office",
      "id": "springfield-il-mayor-misty-buscher",
      "name": "Misty Buscher",
      "title": "Mayor",
      "type": "elected"
    }
  ],
  "services": [
    {
      "agency_id": "springfield-il-city-clerk",
      "category": "permits_licenses",
      "fees": "$50",
      "id": "springfield-il-business-license",
      "name": "Business License",
      "url": "https://www.springfield.il.us/clerk/business-license"
    }
  ],
  "version": "1.0"
}
Download Schema |

Quick Start Template

Download a complete template with placeholder data to get started quickly.

Download Template