{ "openapi": "3.1.0", "info": { "title": "Linkai Digital public content API", "version": "1.0.0", "summary": "Read-only JSON for the public content on www.linkaidigital.com.au.", "description": "Structured access to the same published facts the website renders: company identity and\ncontact details, the service catalogue, the industries served, and published pricing.\n\nEvery response is generated at build time from the site’s own content files, so the JSON\nand the HTML cannot disagree. No authentication, no rate limit, no write operations —\nGET and HEAD only. All amounts are AUD and exclude GST.\n\nStart at /api/index.json to discover every endpoint.\n\n## Versioning\n\nEvery endpoint is published twice. `/api/v1/...` is pinned: it keeps this\nresponse shape for as long as v1 is supported. `/api/...` is an unversioned\nalias that always points at the current major version. Integrate against the pinned\npath if a change in shape would break you; use the alias if you always want the latest.\n\nA breaking change to a response shape ships as a NEW major under a new path\n(`/api/v2/...`). The existing version keeps working. Additive changes —\nnew optional fields, new endpoints — happen in place and are not breaking.\n\n## Deprecation\n\nBefore a version is withdrawn, its responses carry `Deprecation: true` (RFC 9745) and\n`Sunset: ` (RFC 8594) naming the date it stops being served, plus a `Link`\nheader with `rel=\"deprecation\"` pointing at the replacement. The minimum notice is\n**six months** between the first Sunset header and the endpoint being withdrawn.\nNothing is withdrawn without those headers appearing first.\n\n## Limits\n\nNo authentication, no API key, and no rate limit: these are static files on a CDN, so\nthere is no per-client quota to report and no RateLimit headers are emitted. Please\nstill be reasonable. If that ever changes, the RFC 9331 RateLimit headers will appear\nhere and be documented before enforcement begins.", "contact": { "name": "Linkai Digital", "email": "hello@linkaidigital.com.au", "url": "https://www.linkaidigital.com.au" }, "license": { "name": "Proprietary — © Linkai Digital", "url": "https://www.linkaidigital.com.au/terms/" } }, "servers": [ { "url": "https://www.linkaidigital.com.au", "description": "Production" } ], "security": [], "tags": [ { "name": "content", "description": "Published website content, as JSON." } ], "paths": { "/api/index.json": { "get": { "operationId": "getApiIndex", "summary": "List the available endpoints", "description": "Discovery document: every machine-readable endpoint this site publishes, with a link to the OpenAPI specification. Equivalent human page: https://www.linkaidigital.com.au/ Unversioned alias, always the current major version (v1 today). Integrations that must not change under them should use https://www.linkaidigital.com.au/api/v1/index.json.", "tags": [ "content" ], "responses": { "200": { "description": "List the available endpoints", "content": { "application/json": { "schema": { "type": "object", "description": "Discovery document: every machine-readable endpoint this site publishes, with a link to the OpenAPI specification.", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "description": "Every machine-readable endpoint this site publishes.", "required": [ "openapi", "endpoints" ], "properties": { "openapi": { "type": "string", "format": "uri", "description": "The OpenAPI document." }, "endpoints": { "type": "array", "items": { "type": "object", "required": [ "operation_id", "url", "summary" ], "properties": { "operation_id": { "type": "string", "description": "Matches the operationId in the OpenAPI document." }, "url": { "type": "string", "format": "uri", "description": "The endpoint." }, "summary": { "type": "string", "description": "One line on what it returns." }, "description": { "type": "string", "description": "Longer explanation." }, "html": { "type": "string", "format": "uri", "description": "The human-readable page carrying the same facts." } } } } } }, "meta": { "type": "object", "description": "What this payload is, where it came from, and when it was built.", "required": [ "source", "generated_at", "resource" ], "properties": { "source": { "type": "string", "format": "uri", "description": "The site these facts are published from." }, "generated_at": { "type": "string", "format": "date-time", "description": "Build time of the deploy that produced this file, not request time. These are static files; they are only as fresh as the last deploy." }, "resource": { "type": "string", "description": "Stable identifier for this endpoint's payload, e.g. \"pricing\"." }, "description": { "type": "string", "description": "One line on what the payload contains." }, "count": { "type": "integer", "minimum": 0, "description": "Number of items in `data`, where `data` is a list." } } }, "links": { "type": "object", "description": "Absolute URLs. Always includes `self`, the OpenAPI document and the equivalent human page.", "required": [ "self", "openapi" ], "properties": { "self": { "type": "string", "format": "uri", "description": "This endpoint." }, "openapi": { "type": "string", "format": "uri", "description": "The OpenAPI document describing it." }, "api_index": { "type": "string", "format": "uri", "description": "The list of every endpoint on this site." }, "html": { "type": "string", "format": "uri", "description": "The human-readable page carrying the same facts." } }, "additionalProperties": { "type": "string", "format": "uri" } } } } } } }, "404": { "description": "No endpoint exists at that path.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "The endpoint exists but only answers GET and HEAD.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "The Accept header asked for a media type this site cannot serve.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/company.json": { "get": { "operationId": "getCompany", "summary": "Company identity and contact facts", "description": "Legal name, ABN, email, phone, Sydney address, Google Business Profile, service area and currency for Linkai Digital. Equivalent human page: https://www.linkaidigital.com.au/about/ Unversioned alias, always the current major version (v1 today). Integrations that must not change under them should use https://www.linkaidigital.com.au/api/v1/company.json.", "tags": [ "content" ], "responses": { "200": { "description": "Company identity and contact facts", "content": { "application/json": { "schema": { "type": "object", "description": "Legal name, ABN, email, phone, Sydney address, Google Business Profile, service area and currency for Linkai Digital.", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "description": "Identity, contact and service-area facts for Linkai Digital.", "required": [ "name", "legal_name", "abn", "url", "email", "telephone", "address", "currency" ], "properties": { "name": { "type": "string", "description": "Trading name. Always \"Linkai Digital\" — never \"LinkAI\"." }, "legal_name": { "type": "string", "description": "Registered legal entity." }, "abn": { "type": "string", "description": "Australian Business Number, space-separated." }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 code of the country the business is registered in." }, "url": { "type": "string", "format": "uri", "description": "Canonical website." }, "email": { "type": "string", "format": "uri", "description": "Public contact email address." }, "telephone": { "type": "string", "description": "E.164 phone number." }, "telephone_display": { "type": "string", "description": "The same number as written for an Australian reader." }, "address": { "type": "object", "description": "Registered premises. Work is delivered online, so this is not a limit on who can be served.", "required": [ "locality", "region", "country", "formatted" ], "properties": { "street_address": { "type": "string", "description": "Street and unit." }, "locality": { "type": "string", "description": "City or suburb." }, "region": { "type": "string", "description": "State or territory." }, "postal_code": { "type": "string", "description": "Postcode." }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 code." }, "formatted": { "type": "string", "description": "The whole address on one line." } } }, "google_business_profile": { "type": "string", "format": "uri", "description": "Google Business Profile link." }, "service_area": { "type": "object", "description": "Where Linkai delivers. Read `serves_international` before telling anyone they are out of scope.", "required": [ "based_in", "serves_international" ], "properties": { "type": { "type": "string", "description": "Granularity of `name`, e.g. \"country\"." }, "name": { "type": "string", "description": "Primary market." }, "based_in": { "type": "string", "description": "Where the business physically is." }, "serves_international": { "type": "boolean", "description": "True when clients outside the primary market are served." }, "note": { "type": "string", "description": "Plain-language explanation of the delivery model." }, "specialisation": { "type": "string", "description": "Any offer aimed specifically at a non-primary market." } } }, "currency": { "type": "string", "description": "ISO 4217 code for every price published by this business." }, "gst_registered": { "type": "boolean", "description": "Whether the business is registered for GST." }, "prices_include_gst": { "type": "boolean", "description": "False means every published figure is exclusive of GST." } } }, "meta": { "type": "object", "description": "What this payload is, where it came from, and when it was built.", "required": [ "source", "generated_at", "resource" ], "properties": { "source": { "type": "string", "format": "uri", "description": "The site these facts are published from." }, "generated_at": { "type": "string", "format": "date-time", "description": "Build time of the deploy that produced this file, not request time. These are static files; they are only as fresh as the last deploy." }, "resource": { "type": "string", "description": "Stable identifier for this endpoint's payload, e.g. \"pricing\"." }, "description": { "type": "string", "description": "One line on what the payload contains." }, "count": { "type": "integer", "minimum": 0, "description": "Number of items in `data`, where `data` is a list." } } }, "links": { "type": "object", "description": "Absolute URLs. Always includes `self`, the OpenAPI document and the equivalent human page.", "required": [ "self", "openapi" ], "properties": { "self": { "type": "string", "format": "uri", "description": "This endpoint." }, "openapi": { "type": "string", "format": "uri", "description": "The OpenAPI document describing it." }, "api_index": { "type": "string", "format": "uri", "description": "The list of every endpoint on this site." }, "html": { "type": "string", "format": "uri", "description": "The human-readable page carrying the same facts." } }, "additionalProperties": { "type": "string", "format": "uri" } } } } } } }, "404": { "description": "No endpoint exists at that path.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "The endpoint exists but only answers GET and HEAD.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "The Accept header asked for a media type this site cannot serve.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/services.json": { "get": { "operationId": "getServices", "summary": "The service catalogue", "description": "Every published service, with its slug, growth pillar, description and the URL of its page. Equivalent human page: https://www.linkaidigital.com.au/services/ Unversioned alias, always the current major version (v1 today). Integrations that must not change under them should use https://www.linkaidigital.com.au/api/v1/services.json.", "tags": [ "content" ], "responses": { "200": { "description": "The service catalogue", "content": { "application/json": { "schema": { "type": "object", "description": "Every published service, with its slug, growth pillar, description and the URL of its page.", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "array", "items": { "type": "object", "description": "One published service.", "required": [ "slug", "name", "pillar", "description", "url" ], "properties": { "slug": { "type": "string", "description": "URL-safe identifier, stable across deploys." }, "name": { "type": "string", "description": "Service name as used in navigation." }, "pillar": { "type": "string", "description": "The growth outcome this service sits under.", "enum": [ "Get your time back", "Get more clients", "Win every client", "Specialised" ] }, "description": { "type": "string", "description": "One-paragraph summary." }, "headline": { "type": "string", "description": "The page's main heading." }, "summary": { "type": "string", "description": "The sub-heading beneath it." }, "url": { "type": "string", "format": "uri", "description": "The service page." } } }, "description": "Every published service." }, "meta": { "type": "object", "description": "What this payload is, where it came from, and when it was built.", "required": [ "source", "generated_at", "resource" ], "properties": { "source": { "type": "string", "format": "uri", "description": "The site these facts are published from." }, "generated_at": { "type": "string", "format": "date-time", "description": "Build time of the deploy that produced this file, not request time. These are static files; they are only as fresh as the last deploy." }, "resource": { "type": "string", "description": "Stable identifier for this endpoint's payload, e.g. \"pricing\"." }, "description": { "type": "string", "description": "One line on what the payload contains." }, "count": { "type": "integer", "minimum": 0, "description": "Number of items in `data`, where `data` is a list." } } }, "links": { "type": "object", "description": "Absolute URLs. Always includes `self`, the OpenAPI document and the equivalent human page.", "required": [ "self", "openapi" ], "properties": { "self": { "type": "string", "format": "uri", "description": "This endpoint." }, "openapi": { "type": "string", "format": "uri", "description": "The OpenAPI document describing it." }, "api_index": { "type": "string", "format": "uri", "description": "The list of every endpoint on this site." }, "html": { "type": "string", "format": "uri", "description": "The human-readable page carrying the same facts." } }, "additionalProperties": { "type": "string", "format": "uri" } } } } } } }, "404": { "description": "No endpoint exists at that path.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "The endpoint exists but only answers GET and HEAD.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "The Accept header asked for a media type this site cannot serve.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/industries.json": { "get": { "operationId": "getIndustries", "summary": "The industries served", "description": "Every industry with a dedicated page, with its slug, group, description and page URL. Equivalent human page: https://www.linkaidigital.com.au/industries/ Unversioned alias, always the current major version (v1 today). Integrations that must not change under them should use https://www.linkaidigital.com.au/api/v1/industries.json.", "tags": [ "content" ], "responses": { "200": { "description": "The industries served", "content": { "application/json": { "schema": { "type": "object", "description": "Every industry with a dedicated page, with its slug, group, description and page URL.", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "array", "items": { "type": "object", "description": "One industry with a dedicated page.", "required": [ "slug", "name", "group", "description", "url" ], "properties": { "slug": { "type": "string", "description": "URL-safe identifier, stable across deploys." }, "name": { "type": "string", "description": "Industry name as used in navigation." }, "group": { "type": "string", "description": "The navigation group this industry belongs to.", "enum": [ "Trades & Services", "Health & Care", "Professional" ] }, "description": { "type": "string", "description": "One-paragraph summary." }, "headline": { "type": "string", "description": "The page's main heading." }, "summary": { "type": "string", "description": "The sub-heading beneath it." }, "url": { "type": "string", "format": "uri", "description": "The industry page. Industries live at the site root, not under /industries/." } } }, "description": "Every industry with a dedicated page." }, "meta": { "type": "object", "description": "What this payload is, where it came from, and when it was built.", "required": [ "source", "generated_at", "resource" ], "properties": { "source": { "type": "string", "format": "uri", "description": "The site these facts are published from." }, "generated_at": { "type": "string", "format": "date-time", "description": "Build time of the deploy that produced this file, not request time. These are static files; they are only as fresh as the last deploy." }, "resource": { "type": "string", "description": "Stable identifier for this endpoint's payload, e.g. \"pricing\"." }, "description": { "type": "string", "description": "One line on what the payload contains." }, "count": { "type": "integer", "minimum": 0, "description": "Number of items in `data`, where `data` is a list." } } }, "links": { "type": "object", "description": "Absolute URLs. Always includes `self`, the OpenAPI document and the equivalent human page.", "required": [ "self", "openapi" ], "properties": { "self": { "type": "string", "format": "uri", "description": "This endpoint." }, "openapi": { "type": "string", "format": "uri", "description": "The OpenAPI document describing it." }, "api_index": { "type": "string", "format": "uri", "description": "The list of every endpoint on this site." }, "html": { "type": "string", "format": "uri", "description": "The human-readable page carrying the same facts." } }, "additionalProperties": { "type": "string", "format": "uri" } } } } } } }, "404": { "description": "No endpoint exists at that path.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "The endpoint exists but only answers GET and HEAD.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "The Accept header asked for a media type this site cannot serve.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/pricing.json": { "get": { "operationId": "getPricing", "summary": "Published pricing by audience", "description": "Managed package pricing for trades and clinics, audit-led offers for professional services, and the setup, GST, fair-use and minimum-term qualifiers that apply to every figure. All amounts AUD, excluding GST. Equivalent human page: https://www.linkaidigital.com.au/pricing/ Unversioned alias, always the current major version (v1 today). Integrations that must not change under them should use https://www.linkaidigital.com.au/api/v1/pricing.json.", "tags": [ "content" ], "responses": { "200": { "description": "Published pricing by audience", "content": { "application/json": { "schema": { "type": "object", "description": "Managed package pricing for trades and clinics, audit-led offers for professional services, and the setup, GST, fair-use and minimum-term qualifiers that apply to every figure. All amounts AUD, excluding GST.", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "description": "Published pricing by audience. All amounts AUD, excluding GST.", "required": [ "notes", "audiences" ], "properties": { "notes": { "type": "object", "description": "The qualifiers that apply to EVERY figure in this payload. Quoting a price without them misleads the reader.", "required": [ "setup", "fair_use", "minimum_term" ], "properties": { "setup": { "type": "string", "description": "That setup is a separate one-off cost, not included in the monthly figure." }, "fair_use": { "type": "string", "description": "That heavy SMS, call or AI usage is requoted." }, "minimum_term": { "type": "string", "description": "The minimum commitment on managed packages." }, "confirmation": { "type": "string", "description": "When the exact setup cost is confirmed." } } }, "audiences": { "type": "array", "description": "One entry per audience. Pricing model differs between them.", "items": { "type": "object", "required": [ "key", "name", "url", "model" ], "properties": { "key": { "type": "string", "description": "Stable identifier for the audience." }, "name": { "type": "string", "description": "Audience name." }, "url": { "type": "string", "format": "uri", "description": "The pricing page for this audience." }, "model": { "type": "string", "enum": [ "managed_monthly_packages", "audit_led" ], "description": "How this audience is priced. `audit_led` audiences have no monthly packages." }, "packages": { "type": "array", "items": { "type": "object", "description": "A managed monthly package. The figure is a FROM price and excludes GST and setup.", "required": [ "slug", "name", "billing_period", "price_from_aud_ex_gst", "price_display", "includes" ], "properties": { "slug": { "type": "string", "description": "URL-safe identifier." }, "name": { "type": "string", "description": "Package name." }, "pillar": { "type": "string", "description": "The outcome the package is sold against." }, "tagline": { "type": "string", "description": "One line on what it does." }, "for_who": { "type": "string", "description": "Who it suits." }, "billing_period": { "type": "string", "enum": [ "month" ], "description": "Billing cadence." }, "price_from_aud_ex_gst": { "type": "number", "description": "Lowest monthly price in AUD, excluding GST and setup." }, "price_display": { "type": "string", "description": "The figure written out with its qualifiers. Prefer this over formatting the number yourself." }, "includes": { "type": "array", "items": { "type": "string" }, "description": "What the package covers." } } }, "description": "Present when `model` is managed_monthly_packages." }, "entry_offers": { "type": "array", "items": { "type": "object", "description": "A low-cost or free way in, below the managed packages.", "required": [ "name", "price_display", "description", "url" ], "properties": { "name": { "type": "string", "description": "Offer name." }, "price_display": { "type": "string", "description": "Price as written, e.g. \"Free\" or \"$297 + GST\"." }, "description": { "type": "string", "description": "What it covers." }, "url": { "type": "string", "format": "uri", "description": "Where to get it." } } }, "description": "Ways in below the packages." }, "notes": { "type": "object", "description": "The qualifiers that apply to EVERY figure in this payload. Quoting a price without them misleads the reader.", "required": [ "setup", "fair_use", "minimum_term" ], "properties": { "setup": { "type": "string", "description": "That setup is a separate one-off cost, not included in the monthly figure." }, "fair_use": { "type": "string", "description": "That heavy SMS, call or AI usage is requoted." }, "minimum_term": { "type": "string", "description": "The minimum commitment on managed packages." }, "confirmation": { "type": "string", "description": "When the exact setup cost is confirmed." } } }, "groups": { "type": "array", "description": "Present when `model` is audit_led: offers grouped by kind.", "items": { "type": "object", "required": [ "group", "offers" ], "properties": { "group": { "type": "string", "description": "Group name." }, "summary": { "type": "string", "description": "What this group of offers is for." }, "offers": { "type": "array", "items": { "type": "object", "required": [ "name", "price_display", "description" ], "properties": { "name": { "type": "string", "description": "Offer name." }, "price_display": { "type": "string", "description": "Price as written, e.g. \"from $2,500\" or \"by enquiry\"." }, "description": { "type": "string", "description": "What it covers." }, "note": { "type": "string", "description": "Any qualifier specific to this offer." } } } } } } } } } } } }, "meta": { "type": "object", "description": "What this payload is, where it came from, and when it was built.", "required": [ "source", "generated_at", "resource" ], "properties": { "source": { "type": "string", "format": "uri", "description": "The site these facts are published from." }, "generated_at": { "type": "string", "format": "date-time", "description": "Build time of the deploy that produced this file, not request time. These are static files; they are only as fresh as the last deploy." }, "resource": { "type": "string", "description": "Stable identifier for this endpoint's payload, e.g. \"pricing\"." }, "description": { "type": "string", "description": "One line on what the payload contains." }, "count": { "type": "integer", "minimum": 0, "description": "Number of items in `data`, where `data` is a list." } } }, "links": { "type": "object", "description": "Absolute URLs. Always includes `self`, the OpenAPI document and the equivalent human page.", "required": [ "self", "openapi" ], "properties": { "self": { "type": "string", "format": "uri", "description": "This endpoint." }, "openapi": { "type": "string", "format": "uri", "description": "The OpenAPI document describing it." }, "api_index": { "type": "string", "format": "uri", "description": "The list of every endpoint on this site." }, "html": { "type": "string", "format": "uri", "description": "The human-readable page carrying the same facts." } }, "additionalProperties": { "type": "string", "format": "uri" } } } } } } }, "404": { "description": "No endpoint exists at that path.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "The endpoint exists but only answers GET and HEAD.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "The Accept header asked for a media type this site cannot serve.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/index.json": { "get": { "operationId": "getApiIndexV1", "summary": "List the available endpoints", "description": "Discovery document: every machine-readable endpoint this site publishes, with a link to the OpenAPI specification. Equivalent human page: https://www.linkaidigital.com.au/ Pinned to v1: this path keeps this response shape for as long as v1 is supported.", "tags": [ "content" ], "responses": { "200": { "description": "List the available endpoints", "content": { "application/json": { "schema": { "type": "object", "description": "Discovery document: every machine-readable endpoint this site publishes, with a link to the OpenAPI specification.", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "description": "Every machine-readable endpoint this site publishes.", "required": [ "openapi", "endpoints" ], "properties": { "openapi": { "type": "string", "format": "uri", "description": "The OpenAPI document." }, "endpoints": { "type": "array", "items": { "type": "object", "required": [ "operation_id", "url", "summary" ], "properties": { "operation_id": { "type": "string", "description": "Matches the operationId in the OpenAPI document." }, "url": { "type": "string", "format": "uri", "description": "The endpoint." }, "summary": { "type": "string", "description": "One line on what it returns." }, "description": { "type": "string", "description": "Longer explanation." }, "html": { "type": "string", "format": "uri", "description": "The human-readable page carrying the same facts." } } } } } }, "meta": { "type": "object", "description": "What this payload is, where it came from, and when it was built.", "required": [ "source", "generated_at", "resource" ], "properties": { "source": { "type": "string", "format": "uri", "description": "The site these facts are published from." }, "generated_at": { "type": "string", "format": "date-time", "description": "Build time of the deploy that produced this file, not request time. These are static files; they are only as fresh as the last deploy." }, "resource": { "type": "string", "description": "Stable identifier for this endpoint's payload, e.g. \"pricing\"." }, "description": { "type": "string", "description": "One line on what the payload contains." }, "count": { "type": "integer", "minimum": 0, "description": "Number of items in `data`, where `data` is a list." } } }, "links": { "type": "object", "description": "Absolute URLs. Always includes `self`, the OpenAPI document and the equivalent human page.", "required": [ "self", "openapi" ], "properties": { "self": { "type": "string", "format": "uri", "description": "This endpoint." }, "openapi": { "type": "string", "format": "uri", "description": "The OpenAPI document describing it." }, "api_index": { "type": "string", "format": "uri", "description": "The list of every endpoint on this site." }, "html": { "type": "string", "format": "uri", "description": "The human-readable page carrying the same facts." } }, "additionalProperties": { "type": "string", "format": "uri" } } } } } } }, "404": { "description": "No endpoint exists at that path.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "The endpoint exists but only answers GET and HEAD.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "The Accept header asked for a media type this site cannot serve.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/company.json": { "get": { "operationId": "getCompanyV1", "summary": "Company identity and contact facts", "description": "Legal name, ABN, email, phone, Sydney address, Google Business Profile, service area and currency for Linkai Digital. Equivalent human page: https://www.linkaidigital.com.au/about/ Pinned to v1: this path keeps this response shape for as long as v1 is supported.", "tags": [ "content" ], "responses": { "200": { "description": "Company identity and contact facts", "content": { "application/json": { "schema": { "type": "object", "description": "Legal name, ABN, email, phone, Sydney address, Google Business Profile, service area and currency for Linkai Digital.", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "description": "Identity, contact and service-area facts for Linkai Digital.", "required": [ "name", "legal_name", "abn", "url", "email", "telephone", "address", "currency" ], "properties": { "name": { "type": "string", "description": "Trading name. Always \"Linkai Digital\" — never \"LinkAI\"." }, "legal_name": { "type": "string", "description": "Registered legal entity." }, "abn": { "type": "string", "description": "Australian Business Number, space-separated." }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 code of the country the business is registered in." }, "url": { "type": "string", "format": "uri", "description": "Canonical website." }, "email": { "type": "string", "format": "uri", "description": "Public contact email address." }, "telephone": { "type": "string", "description": "E.164 phone number." }, "telephone_display": { "type": "string", "description": "The same number as written for an Australian reader." }, "address": { "type": "object", "description": "Registered premises. Work is delivered online, so this is not a limit on who can be served.", "required": [ "locality", "region", "country", "formatted" ], "properties": { "street_address": { "type": "string", "description": "Street and unit." }, "locality": { "type": "string", "description": "City or suburb." }, "region": { "type": "string", "description": "State or territory." }, "postal_code": { "type": "string", "description": "Postcode." }, "country": { "type": "string", "description": "ISO 3166-1 alpha-2 code." }, "formatted": { "type": "string", "description": "The whole address on one line." } } }, "google_business_profile": { "type": "string", "format": "uri", "description": "Google Business Profile link." }, "service_area": { "type": "object", "description": "Where Linkai delivers. Read `serves_international` before telling anyone they are out of scope.", "required": [ "based_in", "serves_international" ], "properties": { "type": { "type": "string", "description": "Granularity of `name`, e.g. \"country\"." }, "name": { "type": "string", "description": "Primary market." }, "based_in": { "type": "string", "description": "Where the business physically is." }, "serves_international": { "type": "boolean", "description": "True when clients outside the primary market are served." }, "note": { "type": "string", "description": "Plain-language explanation of the delivery model." }, "specialisation": { "type": "string", "description": "Any offer aimed specifically at a non-primary market." } } }, "currency": { "type": "string", "description": "ISO 4217 code for every price published by this business." }, "gst_registered": { "type": "boolean", "description": "Whether the business is registered for GST." }, "prices_include_gst": { "type": "boolean", "description": "False means every published figure is exclusive of GST." } } }, "meta": { "type": "object", "description": "What this payload is, where it came from, and when it was built.", "required": [ "source", "generated_at", "resource" ], "properties": { "source": { "type": "string", "format": "uri", "description": "The site these facts are published from." }, "generated_at": { "type": "string", "format": "date-time", "description": "Build time of the deploy that produced this file, not request time. These are static files; they are only as fresh as the last deploy." }, "resource": { "type": "string", "description": "Stable identifier for this endpoint's payload, e.g. \"pricing\"." }, "description": { "type": "string", "description": "One line on what the payload contains." }, "count": { "type": "integer", "minimum": 0, "description": "Number of items in `data`, where `data` is a list." } } }, "links": { "type": "object", "description": "Absolute URLs. Always includes `self`, the OpenAPI document and the equivalent human page.", "required": [ "self", "openapi" ], "properties": { "self": { "type": "string", "format": "uri", "description": "This endpoint." }, "openapi": { "type": "string", "format": "uri", "description": "The OpenAPI document describing it." }, "api_index": { "type": "string", "format": "uri", "description": "The list of every endpoint on this site." }, "html": { "type": "string", "format": "uri", "description": "The human-readable page carrying the same facts." } }, "additionalProperties": { "type": "string", "format": "uri" } } } } } } }, "404": { "description": "No endpoint exists at that path.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "The endpoint exists but only answers GET and HEAD.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "The Accept header asked for a media type this site cannot serve.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/services.json": { "get": { "operationId": "getServicesV1", "summary": "The service catalogue", "description": "Every published service, with its slug, growth pillar, description and the URL of its page. Equivalent human page: https://www.linkaidigital.com.au/services/ Pinned to v1: this path keeps this response shape for as long as v1 is supported.", "tags": [ "content" ], "responses": { "200": { "description": "The service catalogue", "content": { "application/json": { "schema": { "type": "object", "description": "Every published service, with its slug, growth pillar, description and the URL of its page.", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "array", "items": { "type": "object", "description": "One published service.", "required": [ "slug", "name", "pillar", "description", "url" ], "properties": { "slug": { "type": "string", "description": "URL-safe identifier, stable across deploys." }, "name": { "type": "string", "description": "Service name as used in navigation." }, "pillar": { "type": "string", "description": "The growth outcome this service sits under.", "enum": [ "Get your time back", "Get more clients", "Win every client", "Specialised" ] }, "description": { "type": "string", "description": "One-paragraph summary." }, "headline": { "type": "string", "description": "The page's main heading." }, "summary": { "type": "string", "description": "The sub-heading beneath it." }, "url": { "type": "string", "format": "uri", "description": "The service page." } } }, "description": "Every published service." }, "meta": { "type": "object", "description": "What this payload is, where it came from, and when it was built.", "required": [ "source", "generated_at", "resource" ], "properties": { "source": { "type": "string", "format": "uri", "description": "The site these facts are published from." }, "generated_at": { "type": "string", "format": "date-time", "description": "Build time of the deploy that produced this file, not request time. These are static files; they are only as fresh as the last deploy." }, "resource": { "type": "string", "description": "Stable identifier for this endpoint's payload, e.g. \"pricing\"." }, "description": { "type": "string", "description": "One line on what the payload contains." }, "count": { "type": "integer", "minimum": 0, "description": "Number of items in `data`, where `data` is a list." } } }, "links": { "type": "object", "description": "Absolute URLs. Always includes `self`, the OpenAPI document and the equivalent human page.", "required": [ "self", "openapi" ], "properties": { "self": { "type": "string", "format": "uri", "description": "This endpoint." }, "openapi": { "type": "string", "format": "uri", "description": "The OpenAPI document describing it." }, "api_index": { "type": "string", "format": "uri", "description": "The list of every endpoint on this site." }, "html": { "type": "string", "format": "uri", "description": "The human-readable page carrying the same facts." } }, "additionalProperties": { "type": "string", "format": "uri" } } } } } } }, "404": { "description": "No endpoint exists at that path.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "The endpoint exists but only answers GET and HEAD.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "The Accept header asked for a media type this site cannot serve.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/industries.json": { "get": { "operationId": "getIndustriesV1", "summary": "The industries served", "description": "Every industry with a dedicated page, with its slug, group, description and page URL. Equivalent human page: https://www.linkaidigital.com.au/industries/ Pinned to v1: this path keeps this response shape for as long as v1 is supported.", "tags": [ "content" ], "responses": { "200": { "description": "The industries served", "content": { "application/json": { "schema": { "type": "object", "description": "Every industry with a dedicated page, with its slug, group, description and page URL.", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "array", "items": { "type": "object", "description": "One industry with a dedicated page.", "required": [ "slug", "name", "group", "description", "url" ], "properties": { "slug": { "type": "string", "description": "URL-safe identifier, stable across deploys." }, "name": { "type": "string", "description": "Industry name as used in navigation." }, "group": { "type": "string", "description": "The navigation group this industry belongs to.", "enum": [ "Trades & Services", "Health & Care", "Professional" ] }, "description": { "type": "string", "description": "One-paragraph summary." }, "headline": { "type": "string", "description": "The page's main heading." }, "summary": { "type": "string", "description": "The sub-heading beneath it." }, "url": { "type": "string", "format": "uri", "description": "The industry page. Industries live at the site root, not under /industries/." } } }, "description": "Every industry with a dedicated page." }, "meta": { "type": "object", "description": "What this payload is, where it came from, and when it was built.", "required": [ "source", "generated_at", "resource" ], "properties": { "source": { "type": "string", "format": "uri", "description": "The site these facts are published from." }, "generated_at": { "type": "string", "format": "date-time", "description": "Build time of the deploy that produced this file, not request time. These are static files; they are only as fresh as the last deploy." }, "resource": { "type": "string", "description": "Stable identifier for this endpoint's payload, e.g. \"pricing\"." }, "description": { "type": "string", "description": "One line on what the payload contains." }, "count": { "type": "integer", "minimum": 0, "description": "Number of items in `data`, where `data` is a list." } } }, "links": { "type": "object", "description": "Absolute URLs. Always includes `self`, the OpenAPI document and the equivalent human page.", "required": [ "self", "openapi" ], "properties": { "self": { "type": "string", "format": "uri", "description": "This endpoint." }, "openapi": { "type": "string", "format": "uri", "description": "The OpenAPI document describing it." }, "api_index": { "type": "string", "format": "uri", "description": "The list of every endpoint on this site." }, "html": { "type": "string", "format": "uri", "description": "The human-readable page carrying the same facts." } }, "additionalProperties": { "type": "string", "format": "uri" } } } } } } }, "404": { "description": "No endpoint exists at that path.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "The endpoint exists but only answers GET and HEAD.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "The Accept header asked for a media type this site cannot serve.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } }, "/api/v1/pricing.json": { "get": { "operationId": "getPricingV1", "summary": "Published pricing by audience", "description": "Managed package pricing for trades and clinics, audit-led offers for professional services, and the setup, GST, fair-use and minimum-term qualifiers that apply to every figure. All amounts AUD, excluding GST. Equivalent human page: https://www.linkaidigital.com.au/pricing/ Pinned to v1: this path keeps this response shape for as long as v1 is supported.", "tags": [ "content" ], "responses": { "200": { "description": "Published pricing by audience", "content": { "application/json": { "schema": { "type": "object", "description": "Managed package pricing for trades and clinics, audit-led offers for professional services, and the setup, GST, fair-use and minimum-term qualifiers that apply to every figure. All amounts AUD, excluding GST.", "required": [ "data", "meta", "links" ], "properties": { "data": { "type": "object", "description": "Published pricing by audience. All amounts AUD, excluding GST.", "required": [ "notes", "audiences" ], "properties": { "notes": { "type": "object", "description": "The qualifiers that apply to EVERY figure in this payload. Quoting a price without them misleads the reader.", "required": [ "setup", "fair_use", "minimum_term" ], "properties": { "setup": { "type": "string", "description": "That setup is a separate one-off cost, not included in the monthly figure." }, "fair_use": { "type": "string", "description": "That heavy SMS, call or AI usage is requoted." }, "minimum_term": { "type": "string", "description": "The minimum commitment on managed packages." }, "confirmation": { "type": "string", "description": "When the exact setup cost is confirmed." } } }, "audiences": { "type": "array", "description": "One entry per audience. Pricing model differs between them.", "items": { "type": "object", "required": [ "key", "name", "url", "model" ], "properties": { "key": { "type": "string", "description": "Stable identifier for the audience." }, "name": { "type": "string", "description": "Audience name." }, "url": { "type": "string", "format": "uri", "description": "The pricing page for this audience." }, "model": { "type": "string", "enum": [ "managed_monthly_packages", "audit_led" ], "description": "How this audience is priced. `audit_led` audiences have no monthly packages." }, "packages": { "type": "array", "items": { "type": "object", "description": "A managed monthly package. The figure is a FROM price and excludes GST and setup.", "required": [ "slug", "name", "billing_period", "price_from_aud_ex_gst", "price_display", "includes" ], "properties": { "slug": { "type": "string", "description": "URL-safe identifier." }, "name": { "type": "string", "description": "Package name." }, "pillar": { "type": "string", "description": "The outcome the package is sold against." }, "tagline": { "type": "string", "description": "One line on what it does." }, "for_who": { "type": "string", "description": "Who it suits." }, "billing_period": { "type": "string", "enum": [ "month" ], "description": "Billing cadence." }, "price_from_aud_ex_gst": { "type": "number", "description": "Lowest monthly price in AUD, excluding GST and setup." }, "price_display": { "type": "string", "description": "The figure written out with its qualifiers. Prefer this over formatting the number yourself." }, "includes": { "type": "array", "items": { "type": "string" }, "description": "What the package covers." } } }, "description": "Present when `model` is managed_monthly_packages." }, "entry_offers": { "type": "array", "items": { "type": "object", "description": "A low-cost or free way in, below the managed packages.", "required": [ "name", "price_display", "description", "url" ], "properties": { "name": { "type": "string", "description": "Offer name." }, "price_display": { "type": "string", "description": "Price as written, e.g. \"Free\" or \"$297 + GST\"." }, "description": { "type": "string", "description": "What it covers." }, "url": { "type": "string", "format": "uri", "description": "Where to get it." } } }, "description": "Ways in below the packages." }, "notes": { "type": "object", "description": "The qualifiers that apply to EVERY figure in this payload. Quoting a price without them misleads the reader.", "required": [ "setup", "fair_use", "minimum_term" ], "properties": { "setup": { "type": "string", "description": "That setup is a separate one-off cost, not included in the monthly figure." }, "fair_use": { "type": "string", "description": "That heavy SMS, call or AI usage is requoted." }, "minimum_term": { "type": "string", "description": "The minimum commitment on managed packages." }, "confirmation": { "type": "string", "description": "When the exact setup cost is confirmed." } } }, "groups": { "type": "array", "description": "Present when `model` is audit_led: offers grouped by kind.", "items": { "type": "object", "required": [ "group", "offers" ], "properties": { "group": { "type": "string", "description": "Group name." }, "summary": { "type": "string", "description": "What this group of offers is for." }, "offers": { "type": "array", "items": { "type": "object", "required": [ "name", "price_display", "description" ], "properties": { "name": { "type": "string", "description": "Offer name." }, "price_display": { "type": "string", "description": "Price as written, e.g. \"from $2,500\" or \"by enquiry\"." }, "description": { "type": "string", "description": "What it covers." }, "note": { "type": "string", "description": "Any qualifier specific to this offer." } } } } } } } } } } } }, "meta": { "type": "object", "description": "What this payload is, where it came from, and when it was built.", "required": [ "source", "generated_at", "resource" ], "properties": { "source": { "type": "string", "format": "uri", "description": "The site these facts are published from." }, "generated_at": { "type": "string", "format": "date-time", "description": "Build time of the deploy that produced this file, not request time. These are static files; they are only as fresh as the last deploy." }, "resource": { "type": "string", "description": "Stable identifier for this endpoint's payload, e.g. \"pricing\"." }, "description": { "type": "string", "description": "One line on what the payload contains." }, "count": { "type": "integer", "minimum": 0, "description": "Number of items in `data`, where `data` is a list." } } }, "links": { "type": "object", "description": "Absolute URLs. Always includes `self`, the OpenAPI document and the equivalent human page.", "required": [ "self", "openapi" ], "properties": { "self": { "type": "string", "format": "uri", "description": "This endpoint." }, "openapi": { "type": "string", "format": "uri", "description": "The OpenAPI document describing it." }, "api_index": { "type": "string", "format": "uri", "description": "The list of every endpoint on this site." }, "html": { "type": "string", "format": "uri", "description": "The human-readable page carrying the same facts." } }, "additionalProperties": { "type": "string", "format": "uri" } } } } } } }, "404": { "description": "No endpoint exists at that path.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "405": { "description": "The endpoint exists but only answers GET and HEAD.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "406": { "description": "The Accept header asked for a media type this site cannot serve.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } }, "500": { "description": "Unexpected server error.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Error" } } } } } } } }, "components": { "schemas": { "Error": { "type": "object", "required": [ "error" ], "properties": { "error": { "type": "object", "required": [ "code", "message", "status", "hint" ], "properties": { "code": { "type": "string", "description": "Stable machine-readable code. Branch on this, not on the message.", "enum": [ "not_found", "method_not_allowed", "not_acceptable" ] }, "message": { "type": "string", "description": "Human-readable explanation." }, "status": { "type": "integer", "description": "HTTP status, repeated for convenience." }, "hint": { "type": "string", "description": "What to do to get a successful response." }, "documentation_url": { "type": "string", "format": "uri" } } } } } } } }