latestOpenAPI 3.0.32026-08-1968196306.2 KB

cf02c9310c0f

integrations

getDocumentationPage

Retrieve a single documentation page including its markdown content

get/v1/integrations/{integrationId}/documentation/{docId}

integrationIdstring uuid required

The integration ID

docIdstring required

'general' for the integration-wide page, otherwise a use case ID

Successfully retrieved documentation page

idstring required

'general' for the integration-wide page, otherwise the use case ID

integration_idstring uuid required

scope'integration' | 'use_case' required

Whether the page documents the whole integration or a single use case

use_case_idstring uuid

The linked use case. Only set when scope is use_case.

titlestring required

created_atstring date-time required

created_bystring nullable

User ID that created the page

updated_atstring date-time required

updated_bystring nullable

User ID of the last edit

contentstring required

Markdown source of the page

{
  "id": "general"
}