API Documentation.

Authentication

Four access modes. Registry and template metadata are open; PMS integrations send an API key, and full plan bodies need a per-account one; community contributions use a browser session. Keyed endpoints fail closed in production.

curl "https://www.openmatterplans.com/api/v1/field-sets/resolve?practiceArea=conveyancing&jurisdiction=AU-QLD" \
  -H "x-omn-api-key: omn_live_xxxxxxxxxxxxxxxx"

# or, equivalently:
  -H "Authorization: Bearer omn_live_xxxxxxxxxxxxxxxx"

Endpoints

GET /api/v1/matter-plans?jurisdiction=AU-QLD&practiceAreaKey=conveyancing

{
  "planSchemaVersion": 1,
  "total": 2, "page": 1, "limit": 20, "pages": 1,
  "data": [
    {
      "id": "94169c3a-a04c-4304-bedb-454bf212ba6d",
      "slug": "au/qld/property/property-purchase-buyer/standard-residential-purchase",
      "title": "Property Purchase (Buyer)",
      "forkLabel": "QLD - Standard Residential Purchase",
      "forkedFromId": null, "forkCount": 0,
      "saliAreaOfLaw": "Real Estate", "saliProcess": "TRANSACTIONAL",
      "practiceArea": "property", "category": "property",
      "practiceAreaKey": "conveyancing",
      "partyRole": "BUYER",
      "countryCode": "AU", "jurisdictionSub": "QLD", "jurisdiction": "AU-QLD",
      "documentLinkCount": 60,
      "contentHash": "b2ad8ecdaa11...",
      "planSchemaVersion": 1,
      "updatedAt": "2026-10-14T06:38:51.605Z",
      "fieldSetSlug": "plan-property_purchase-buyer-94169c3a",
      "fieldsNormalized": true,
      "netVotes": 0
    }
  ]
}

Matter field vocabulary

Templates fill against canonical matter.* tokens that resolve on your side, against your own matter data (matter data never leaves the PMS). Parties are addressed by role (matter.party.purchaser.fullName), never by position. Field sets form a hierarchy of up to five levels, base > area core > country > state > plan; resolve the one for a matter by context rather than hard-coding a token list.

A pdf_form template embeds manifest.json (under /Names → /EmbeddedFiles); a docx_precedent carries the same JSON as the omn/manifest.json part and {placeholder} tags in the body. Each field maps to one rule above, and may also carry label, suggest and describe hints. A rule your engine does not know yet is a no-op: leave the field blank, never error.

Streaming matter plans into your PMS

Plans evolve as practitioners refine them. Rather than re-pull every plan, track freshness off the contentHash and only download what changed. Each plan is bound to a resolved field set from the Matter Field Standard, and every form it uses is filled from that set, so the tokens a PMS pre-fills against travel with the plan.

{
  "id": "a862cc54-b90f-451a-bca3-341bc4e0ff51",
  "title": "Open or Join the Electronic Workspace and Prepare the Transfer",
  "relativeDays": -14,
  "baseKeyDate": "Settlement Date",
  "baseKeyToken": "matter.fieldValues.settlement_date",
  "pmsFieldRefs": ["matter.fieldValues.elno_workspace_id",
                   "matter.fieldValues.settlement_date", "..."],
  "documents": [ { "templateId": "24b2d696-9873-436f-bdaf-fc59334122d8",
                   "formName": "Transfer (Form 1)", "formNumber": "Form 1",
                   "templateType": "docx_precedent", "via": "own",
                   "downloadUrl": "..." } ]
}
// -> due date = the matter's settlement_date minus 14 days;
//    inputs for the workspace id and settlement date on the card,
//    typed from the field set (settlement_date: dataType "date", format "DD/MM/YYYY");
//    the Transfer one click away, filled from the same set.