Networking

List Network site documents

List documents of a network site. Partner-scoped. Supports order, limit, offset and search filters.

get/admin/networking/network-sites-documents

Request

  • Base URL: https://demo.splynx.com/api/2.0
  • URL: https://demo.splynx.com/api/2.0/admin/networking/network-sites-documents
  • Auth: HTTP basic

Query parameters

network_site_idinteger required
Example:1

ID of the parent network site whose documents are returned.

orderobject

Map of column => direction (case-insensitive). Unknown columns or directions are silently dropped.

  • Columns: id, hash_id, title, description, filename_original, thumbnail, created_at, updated_at.
  • Directions: ASC, DESC.

Example: order[id]=DESC.

{
  "id": "DESC"
}
limitinteger
Example:20

Max documents to return. Negative values clamped to 0.

offsetinteger

Documents to skip. Negative values clamped to 0; out-of-range offset returns an empty list.

searchobject

Filter by attribute values nested under main_attributes. Supports standard API v2 operators (LIKE, IN, etc.).

  • Searchable: title, description (other keys silently dropped).
  • network_site_id cannot be widened via search — the controller always enforces the query-parameter value.

Example: search[main_attributes][title][0]=LIKE&search[main_attributes][title][1]=%25foo%25 (encode % as %25).

{
  "main_attributes": {
    "title": [
      "LIKE",
      "%blueprint%"
    ]
  }
}

Response

idinteger

Document ID (primary key).

typestring

Document type identifier used by the download endpoint.

hash_idstring

32-character random hash used by the public download URL.

filename_originalstring

Original filename as uploaded by the client.

filename_uploadedstring

Stored filename on disk.

download_linkstring

Relative admin download URL for the file.

has_thumbnailboolean

True if a thumbnail preview is available on disk for this document.

sizeinteger

File size in bytes.

thumbnail_linkstring

Relative URL to the thumbnail; empty string when has_thumbnail is false.

Example response

[
  {
    "id": 10,
    "type": "networking_network_sites_documents",
    "hash_id": "c325fc52f5c4fe31f0940384599aafb2",
    "filename_original": "site_blueprint.pdf",
    "filename_uploaded": "c0adc27c4f4b1dfe",
    "download_link": "/admin/download?module=networking_network_sites_documents&id=10",
    "size": 228
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.