Skip to main content
GET
/
api
/
stores
/
{orgSlug}
/
{slug}
/
fs
cURL
curl --request GET \
  --url http://localhost/api/stores/{orgSlug}/{slug}/fs
"<string>"

​
Overview

Downloads content from a document family in the store using a file system-style path. This endpoint allows you to retrieve documents by their path within the store’s hierarchical structure.

​
Path Parameters

Query parameters control which file to retrieve:
  • path (string, optional) - The path to the document within the store
  • query (string, optional, default: ”*”) - Query filter for results

​
Response

Returns the binary content of the document with appropriate content type headers and attachment disposition.

​
Example Usage

​
Download a specific file

curl -X GET "https://platform.kodexa.com/api/stores/my-org/invoices/fs?path=2024/january/invoice-001.pdf" \
  -H "x-api-key: your-api-key-here" \
  --output invoice-001.pdf

​
Using Python SDK

from kodexa import KodexaPlatform

platform = KodexaPlatform(url="https://platform.kodexa.com", api_key="your-api-key")

# Get a document by path
content = platform.get_store_content(
    org_slug="my-org",
    slug="invoices",
    path="2024/january/invoice-001.pdf"
)

# Save to file
with open("invoice-001.pdf", "wb") as f:
    f.write(content)

​
Response Details

The response includes:
  • Content-Type: Detected from the file extension or stored metadata
  • Content-Disposition: attachment with original filename
  • Content: Binary stream of the document
If no native content object is available for the document family, returns 404 Not Found.

Path Parameters

​
orgSlug
string
required
​
slug
string
required

Query Parameters

​
query
string

A simple text query that will be applied

​
page
integer
default:0

Zero-based page index (0..N)

​
pageSize
integer
default:10

The size of the page to be returned

​
sort
string

Sorting criteria in the format: property(,asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

​
filter
string

A filter that will be applied

Response

OK

The response is of type file.