EirePlan
    Eireplan API
    Endpoints/Knowledge API

    List Knowledge Docs

    List planning policy documents with filters and pagination.

    Use this request to search the knowledge base and return document metadata in pages.

    #Request

    GET /ext/v1/knowledge/docs

    #When To Use It

    • You need to browse the knowledge catalog.
    • You want to filter by jurisdiction, document type, or policy domain.
    • You need doc_id values for follow-up detail requests.

    #Query Parameters

    ParameterTypeRequiredDescriptionExample(s)
    jurisdictionstringNoFilter by planning system level or local authority. Use National for national guidance.National, Dublin City Council
    document_typestringNoFilter by document type.Ministerial Guidelines
    policy_domainstringNoFilter by planning policy domain or topic area.Housing standards & mix
    limitintegerNoMaximum documents per request, from 1 to 100. Default is 20.50
    offsetintegerNoResult offset for pagination.0

    #Example Request

    curl "https://api.eireplan.ie/ext/v1/knowledge/docs?jurisdiction=National&limit=2" \
  -H "Authorization: Bearer ek_your_api_key_here"

    #Response Structure

    FieldTypeDescription
    documentsarrayList of knowledge documents matching the query.
    totalintegerTotal number of matching documents.
    limitintegerThe applied page size.
    offsetintegerThe applied result offset.
    has_morebooleanWhether another page is available after this one.

    Each item in documents includes:

    FieldTypeDescription
    doc_idstring (UUID)Stable document identifier.
    metadata.document_titlestringFull official title.
    metadata.short_reference_namestringShort reference name for display.
    metadata.planning_system_levelstringNational, Regional, or Local.
    metadata.document_typestringDocument classification.
    metadata.current_statusstringCurrent document status.
    metadata.issuing_body_namestringIssuing authority or organization.
    metadata.key_policy_domainsarrayMain policy themes covered.
    base_urlstringOfficial source URL.
    updated_atstringLast update timestamp in ISO 8601 format.

    #Example Response

    json
    {
  "documents": [
    {
      "doc_id": "7af4c2d9-87ea-4887-8d8f-95e20b25a1a5",
      "metadata": {
        "document_title": "Sustainable Residential Development and Compact Settlements Guidelines",
        "short_reference_name": "SRD Guidelines",
        "planning_system_level": "National",
        "document_type": "Ministerial Guidelines",
        "current_status": "In force",
        "issuing_body_name": "Department of Housing, Local Government and Heritage",
        "key_policy_domains": ["Housing standards & mix", "Urban design & placemaking"]
      },
      "base_url": "https://www.gov.ie/example-guidelines",
      "updated_at": "2026-01-14T11:20:00Z"
    }
  ],
  "total": 42,
  "limit": 2,
  "offset": 0,
  "has_more": true
}

    #Next Step

    Use the returned doc_id with Get Knowledge Document when you want the complete record for a specific document.

    Get Knowledge Document