GET

Integration guides

Get integration guide

/api/v2/integration-guides/{guide_slug}

AUTHENTICATIONNone · publicService ownerdeveloper-platformContract sourceOpenAPISTATUSProduction listed

Purpose and usage

What this endpoint does

Return one versioned integration blueprint and its linked endpoint contracts.

When to use it

Fetch a selected guide's full Markdown narrative and linked capability candidates before implementing its end-to-end controls, reconciliation, and failure handling.

OUTCOME · Inspect

What changes

Read-only projection; it grants no mutation, settlement, traffic, or authority change.

WHY IT MATTERS

Gives people and agents a contract-backed way to inspect integration guide.
Gives human and agentic integrations one discoverable path from service identity and reference data to executable OpenAPI, capability ownership, guides, SDK status, and request-signing controls.

ISOLATION + AUTHORITY

Public service metadata, the OpenAPI document, the capability registry, guides, SDK listings, bearer credentials, step-up grants, and request-signing keys are separate artifacts. Discovery metadata grants no tenant, wallet, custody, payment, settlement, publisher, matching, or trading authority; public signing-key metadata never includes private key material.

BEFORE YOU CALL

No bearer credential is required; apply bounded filters and canonical public identifiers where the contract provides them.
Supply the required guide_slug (path) exactly as defined by the live contract.
Resolve whether the caller needs public discovery, bearer authorization, purpose-bound step-up, or RFC 9421 request signing; do not substitute one mechanism for another.

WHAT TO DO NEXT

Follow the returned authoritative OpenAPI, capability, guide, or SDK link appropriate to the integration task.
Validate executable behavior against deployed OpenAPI rather than inferring it from narrative guidance or package names.

AGENT GUIDANCE

Use integration guide only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
Supply the required guide_slug (path) exactly as defined by the live contract.
Treat deployment identity, OpenAPI schema, capability readiness, guide narrative, SDK publication, bearer authorization, step-up authorization, and request-signing proof as distinct inputs; none substitutes for another.
Use response links and canonical identifiers instead of constructing internal service URLs or scraping the website.

Contract reference

Use the deployed OpenAPI for exact parameters, schemas and security requirements. The tables below provide integration guidance.

Open this operation in OpenAPI

Request and response

Make the request

Examples illustrate integration intent; the referenced OpenAPI operation and component schemas define the executable shape.

PARAMETERS

Headers, path, query, and body

NAMELOCATIONPRESENCETYPE / RULES / PURPOSE

guide_slugpathRequired

published guide slugStable slug returned by the guide catalog.EXAMPLEaccounting-and-payroll-systems

RESPONSES

Status and payload examples

200Full Markdown guide, related capability candidates, source digest, and content format.Read completed · JSON RESPONSE+

{
  "guide": {
    "slug": "accounting-and-payroll-systems",
    "sourcePath": "app/guides/accounting-and-payroll-systems",
    "category": "financial-infrastructure",
    "categoryName": "Financial infrastructure",
    "title": "Accounting and payroll systems",
    "body": "**Overview:** Integrate governed payroll and accounting workflows.\n\n## Integration Flow\n..."
  },
  "relatedEndpoints": [
    {
      "method": "GET",
      "path": "/api/v2/billing/account",
      "title": "BILLING: Get account",
      "status": "implemented-contract",
      "applications": [
        "Billing"
      ]
    }
  ],
  "sourceSha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
  "contentFormat": "text/markdown"
}

INTEGRATION DECISION

CALLER ACTION: Accept the returned representation or receipt, then follow the returned authoritative OpenAPI, capability, guide, or SDK link appropriate to the integration task.
RETRY SAFETY: Repeat only when the integration needs a fresher authoritative projection.
STATE RECONCILIATION: Use returned identifiers and versions as the comparison point for later reads. Refresh the application, credential or callback record; compare scope, key identifier, secret-display state, version, and revocation or rotation receipt.

404No published guide exists for the supplied slug.Resource not visible · JSON RESPONSE+

{
  "code": "guide_not_found",
  "message": "No published guide exists for the supplied slug."
}

INTEGRATION DECISIONguide_not_found

CALLER ACTION: Verify the canonical identifier and authenticated owner boundary. A 404 may intentionally conceal a resource outside the caller's authority.
RETRY SAFETY: Do not retry the unchanged identifier repeatedly. Refresh the relevant collection or lookup before choosing another identifier.
STATE RECONCILIATION: Refresh the application, credential or callback record; compare scope, key identifier, secret-display state, version, and revocation or rotation receipt.
ESCALATE WHEN: Escalate when a secret-bearing result was lost, key or callback state is ambiguous, or least-privilege scope cannot be established.

OPERATIONAL NOTES

Security and lifecycle guarantees

guide.body is Markdown and contentFormat is text/markdown. Render or parse it as untrusted narrative content; it never overrides an endpoint schema or policy.
relatedEndpoints may contain both implemented-contract and planned-contract records. Resolve each method and path against live OpenAPI and exclude any absent operation from executable tooling.
Preserve sourceSha256 with design and conformance evidence so the workflow narrative can be reproduced after catalog changes.
The route is read-only and public. It accepts no query parameters or request body and is cacheable for 300 seconds.

Reference version and availability details

This route is implemented in canonical gateway source and appears in the production OpenAPI snapshot observed 2026-10-02T23:27:55.510Z. Authentication, tenant, feature, venue, and market policy still apply.

Verify the exact production OpenAPI operation Return to the V2 directory