EirePlan
    Eireplan API
    Endpoints/Knowledge API

    Get Knowledge Document

    Fetch one knowledge document by `docId` with full metadata.

    Use this request when you already have a docId and want the complete metadata and resource links for one document.

    #Request

    GET /ext/v1/knowledge/docs/:docId

    #Path Parameters

    ParameterTypeRequiredDescription
    docIdstringYesDocument UUID returned by the list endpoint.

    #Example Request

    curl "https://api.eireplan.ie/ext/v1/knowledge/docs/7af4c2d9-87ea-4887-8d8f-95e20b25a1a5" \
  -H "Authorization: Bearer ek_your_api_key_here"

    #Response Structure

    FieldTypeDescription
    document.doc_idstring (UUID)Unique document identifier.
    document.metadata.document_titlestringOfficial title.
    document.metadata.short_reference_namestringShort reference label.
    document.metadata.document_typestringDocument classification.
    document.metadata.planning_system_levelstringJurisdiction level.
    document.metadata.current_statusstringCurrent validity status.
    document.metadata.issuing_body_namestringIssuing body.
    document.metadata.adoption_commencement_datestringEffective date where available.
    document.metadata.geographic_scopearrayCovered geographic areas.
    document.metadata.used_by_ai_forarrayTypical AI usage categories.
    document.base_urlstringOfficial source link.
    document.pdf_urlstringDirect PDF link when available.
    document.updated_atstringLast updated timestamp.
    document.created_atstringCreation timestamp.

    #Example Response

    json
    {
  "document": {
    "doc_id": "7af4c2d9-87ea-4887-8d8f-95e20b25a1a5",
    "metadata": {
      "document_title": "Sustainable Residential Development and Compact Settlements Guidelines",
      "short_reference_name": "SRD Guidelines",
      "document_type": "Ministerial Guidelines",
      "planning_system_level": "National",
      "current_status": "In force",
      "issuing_body_name": "Department of Housing, Local Government and Heritage",
      "adoption_commencement_date": "2024-03-01",
      "geographic_scope": ["Statewide"],
      "used_by_ai_for": ["Policy compliance checks", "Planning analysis"]
    },
    "base_url": "https://www.gov.ie/example-guidelines",
    "pdf_url": "https://storage.eireplan.ie/knowledge/example-guidelines.pdf",
    "updated_at": "2026-01-14T11:20:00Z",
    "created_at": "2025-11-07T09:02:00Z"
  }
}

    #Where It Fits

    Start with List Knowledge Docs if you do not already know the document identifier you need.