Publish Get publish history

Returns the paginated list of publish events for a documentation

GET
/control-plane/api/v1/documentation/{organization_id}/{documentation_id}/publish/history

Authentication

API Key (BearerAuth)

  • Header: Authorization

Path Parameters

organization_idstringrequired

Organization ID


documentation_idstringrequired

Documentation ID


Query Parameters

pageinteger

Page number (default 1)


page_sizeinteger

Page size (default 20, max 100)


Responses

200
Publish history

Response Fields:

  • items (object[])

  • page (integer)

  • page_size (integer)

  • total (integer)

  • total_pages (integer)

Example:

{
  "items": [
    {
      "entries_count": 0,
      "id": "string",
      "message": "string",
      "published_at": "string",
      "published_by": "string",
      "published_by_name": "string",
      "sections_count": 0,
      "versions_count": 0
    }
  ],
  "page": 0,
  "page_size": 0,
  "total": 0,
  "total_pages": 0
}
400
Bad request

Example:

{
  "key": "value"
}
500
Internal server error

Example:

{
  "key": "value"
}