EPepilot
integrations

getDocumentationPage

Changed on

Retrieve a single documentation page including its markdown content

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

Request

  • Base URL
    https://integration-toolkit.sls.epilot.io
  • URL
    https://integration-toolkit.sls.epilot.io/v1/integrations/{integrationId}/documentation/{docId}
  • Auth
    HTTP bearer

Path parameters

integrationIdstring uuid required

The integration ID

docIdstring required

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

Response

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

Example response

{
  "id": "general"
}

Changes