v50

latestOpenAPI 3.1.0Apache 2.0raw.githubusercontent.com2026-07-068428533.0 MB
API Product Documentation

Get an API Product Document

Returns a document for the API product.

get/v2/api-products/{apiProductId}/documents/{id}

Response

API product document

idstring uuid required
parent_document_idstring uuid nullable required
titlestring required
slugstring required
status'unpublished' | 'published' required
metadataobject required
contentstring required

The unencoded markdown string of the api product document.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}