GET

Integration guides

List integration guides

/api/v2/integration-guides
AUTHENTICATIONNone · publicService ownerdeveloper-platformContract sourceOpenAPISTATUSProduction listed

Purpose and usage

What this endpoint does

List published implementation blueprints by product, industry, use case, and maturity.

When to use it

Search task-oriented business blueprints after selecting a business outcome and before composing several module contracts into one workflow.

OUTCOME · Discover

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 discover integration guides.
  • 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.
  • Use the live OpenAPI schema as the authority for the exact request shape and response model.
  • 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 guides only for the purpose and lifecycle stage described by this operation; do not treat it as authority for an adjacent action.
  • Use the live OpenAPI schema as the authority for the exact request shape and response model.
  • 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
categoryqueryOptional

category slugExact guide category filter.EXAMPLEfinancial-infrastructure

qqueryOptional

stringCase-insensitive search across title, category name, and Markdown content.EXAMPLEpayroll

limitqueryOptional

integer · 1–100 · default 50Maximum guide summaries returned.EXAMPLE50

cursorqueryOptional

opaque offset stringnextCursor from the previous response, reused with the same category and q filters.EXAMPLE50

RESPONSES

Status and payload examples

200Filtered guide summaries, category facets, page metadata, and pinned source digest.Read completed · JSON RESPONSE+
{
  "guides": [
    {
      "slug": "accounting-and-payroll-systems",
      "category": "financial-infrastructure",
      "categoryName": "Financial infrastructure",
      "title": "Accounting and payroll systems",
      "overview": "Integrate governed payroll and accounting workflows.",
      "href": "/api/v2/integration-guides/accounting-and-payroll-systems"
    }
  ],
  "categories": [
    {
      "slug": "financial-infrastructure",
      "name": "Financial infrastructure",
      "guideCount": 8
    }
  ],
  "page": {
    "nextCursor": null,
    "limit": 50,
    "total": 1
  },
  "sourceSha256": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
}
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
For another page, send the returned opaque cursor unchanged with the same filters. Restart without a cursor when a new snapshot is required.
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.
422limit is outside 1 through 100, or cursor is malformed or beyond the filtered catalog.Request must change · JSON RESPONSE+
{
  "code": "invalid_limit",
  "message": "limit is outside 1 through 100, or cursor is malformed or beyond the filtered catalog."
}
INTEGRATION DECISIONinvalid_limit
CALLER ACTION
Rebuild the request from the live OpenAPI operation and correct the rejected method, media type, header, parameter, or body field.
RETRY SAFETY
Do not retry the same invalid request. A corrected read may be sent as a new attempt.
STATE RECONCILIATION
Compare the submitted values with the documented constraints before another call. 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

  • Use category slugs returned in categories. q is content search, not an endpoint or status filter.
  • Treat page.nextCursor as opaque and reuse it only with the same category and q; null means the filtered result is complete.
  • Preserve sourceSha256 to identify the narrative catalog version used by an implementation. The digest does not attest to runtime deployment.
  • Guide summaries explain business composition. Resolve every endpoint against live OpenAPI before generating calls. The public response 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