EirePlan
Eireplan API
Endpoints

Knowledge API

Overview of the knowledge document API and its request pages.

Use the knowledge API to discover planning policy documents, guidelines, and related reference material across Ireland. This API is designed for integrations that need to search the knowledge base first and then inspect one document in more detail.

#What This API Covers

  • National, regional, and local planning policy documents.
  • Filterable document discovery by jurisdiction, document type, and policy domain.
  • Direct follow-up requests for full document metadata and resource links.

#Resource Shape

The core resource is a knowledge document under /ext/v1/knowledge/docs.

  • Use the list request to browse and filter the document catalog.
  • Use the detail request when you already have a doc_id.
  • Expect document metadata to be returned under fields like metadata.document_title, metadata.document_type, and metadata.current_status.

#Requests In This API

RequestMethodPathWhat it does
List Knowledge DocsGET/ext/v1/knowledge/docsSearch and filter the knowledge base with pagination.
Get Knowledge DocumentGET/ext/v1/knowledge/docs/:docIdFetch one document with full metadata and resource links.

#Typical Workflow

  1. Call List Knowledge Docs with filters such as jurisdiction or policy_domain.
  2. Read the returned doc_id from the matching result.
  3. Call Get Knowledge Document with that doc_id to retrieve the complete record.

#Shared Response Patterns

Field or patternMeaning
doc_idStable document identifier you can reuse for follow-up requests.
metadata.*Structured policy document metadata.
base_urlOfficial external source page for the document.
pdf_urlDirect PDF link when available on detail responses.
limit, offset, has_morePagination hints on list responses.

#Example Sequence

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

Use one of the returned doc_id values to continue with:

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

Continue to the request pages above for parameter-by-parameter detail and full response schemas.

List Knowledge Docs