Returns the paginated document posts of one space, newest first, each with its author and topics attached.

space_id is required. Filter with search and an optional search_in list of columns. Only posts whose content type is document and whose status is published or unlisted are listed.

Endpoint

• Method: GET

• Path: /documents

• Edition: PRO

• Controller: DocumentController@index

• Route source: fluent-community-pro/app/Modules/DocumentLibrary/DocumentModule.php:41

• Requires the can_view_documents permission in the space; failure comes back as an error carrying permission_failed.

• Requires FluentCommunity Pro.

Live sample

The request and response below were recorded against a running FluentCommunity install and then anonymised — member names, emails, avatars and post content are fictional, and long collections are trimmed to a few entries.

GET List Documents

GET

/documents

Returns the paginated document posts of one space, newest first, each with its author and topics attached.

Controller: DocumentController@index
Route source: fluent-community-pro/app/Modules/DocumentLibrary/DocumentModule.php:41

Authorizations

ApplicationPasswords

WordPress Application Passwords — use Basic auth with username:application_password.

Type

API Key (header: Authorization)

Responses

Successful response

Content-Type

application/json

{

  

"documents": {

  

  

"current_page": 0,

  

  

"data": [

  

  

  

{

  

  

  

  

"additionalProperties": "string"

  

  

  

}

  

  

],

  

  

"first_page_url": "string",

  

  

"from": "string",

  

  

"last_page": 0,

  

  

"last_page_url": "string",

  

  

"links": [

  

  

  

{

  

  

  

  

"active": true,

  

  

  

  

"label": "string",

  

  

  

  

"url": "string"

  

  

  

}

  

  

],

  

  

"next_page_url": "string",

  

  

"path": "string",

  

  

"per_page": 0,

  

  

"prev_page_url": "string",

  

  

"to": "string",

  

  

"total": 0

  

}

}

GET

/documents

Playground

Authorization

ApplicationPasswords

Samples

Powered by VitePress OpenAPI