List Resources

Method: GET /{api_prefix}/{folder_path}
Auth: Flux API Key

Returns all resources exposed through a Flux API folder. Use this endpoint for lightweight listing, filtering, or full-text search without building a POST body.

URL Pattern

GET https://{environment_key}.fxns.io/{api_prefix}/{folder_path}

Example: GET https://7c9h4pwu.fxns.io/blog/articles

Connect folders to your Flux API via Connect Folder to API before calling this endpoint.

Query Parameters

Pagination

Localization & Formatting

Population & Sorting

Filtering & Search

Vector Search & Boosting

Advanced

Basic Listing

curl -X GET \
  "https://7c9h4pwu.fxns.io/blog/articles?limit=20" \
  -H "Authorization: Secure <access_key>:<signature>"

Filtering

Filters use where__{field}__{operator}={value}. Multiple filters are ANDed; repeating the same field/operator creates OR clauses automatically.

Prefix any operator with not_ to negate it (e.g., where__status__not_in=archived,deleted).

Per-Field Locale Override

By default, filters on localized fields use the search_locale parameter. You can override the locale for a specific field by appending [locale] to the field name:

where__title[fr]__eq=bonjour
where__description[de]__icontains=hallo

This is useful when you need to filter on multiple locales in the same query:

GET https://7c9h4pwu.fxns.io/blog/articles?where__title[en]__eq=Hello&where__title[fr]__eq=Bonjour

Example:

GET https://7c9h4pwu.fxns.io/blog/articles?where__status__eq=published&where__category__in=tech,science&where__rating__gte=4.0

Text & Phrase Search

Use text or phrase search to run full-text matches without switching to the POST-based Search API.

• Provide only one of find_text__query or find_phrase__query.
• find_text__threshold accepts decimals between 0 and 1 (defaults to 1.0). Lower values behave like typo tolerance.
• Leave the __fields parameter empty to search all eligible fields.

GET https://7c9h4pwu.fxns.io/blog/articles?find_text__query=machine%20learning&find_text__fields=title,summary&find_text__threshold=0.8

GET https://7c9h4pwu.fxns.io/blog/articles?find_phrase__query=artificial%20intelligence&find_phrase__fields=title

Vector Search

You can trigger semantic ranking via query parameters instead of switching to the POST-based Search API.

• Set search_mode to vector, hybrid, or vector_boosted.
• Provide vector_search__query. Optional knobs include vector_search__fields, vector_search__top_k (1–100), and vector_search__similarity_threshold.
• For boosted mode, add vector_boost__factor, vector_boost__threshold, and/or vector_boost__max_results.

GET https://7c9h4pwu.fxns.io/blog/articles\
?search_mode=vector\
&vector_search__query=latest%20generative%20ai%20news\
&vector_search__fields=summary\
&return_locales=en,fr

Flux returns the same response shape as a normal list call. When vector search is active, metadata.vector_search_enabled=true and metadata.search_mode echo your mode selection.

Sorting

The sort parameter accepts comma-separated field names. Prefix a field with - for descending order.

GET https://7c9h4pwu.fxns.io/blog/articles?sort=-_sys.created_at,title

Sorting respects search_locale when sorting localized text.

Population

Populate reference or relation fields inline. Flux follows references up to three levels deep.

GET https://7c9h4pwu.fxns.io/blog/articles?populate=author,category.parent

{
  "_sys": {...},
  "data": {
    "title": "Introduction to AI",
    "author": {
      "_sys": {...},
      "data": {"name": "John Smith"}
    },
    "category": {
      "_sys": {...},
      "data": {
        "name": "Technology",
        "parent": {
          "_sys": {...},
          "data": {"name": "Science & Technology"}
        }
      }
    }
  }
}

Population works with return_locales and fallback_locales, and counts toward the response-size limit (~1 MiB).

Localization

• search_locale controls which locale is used for text search, sorting, and locale-aware comparisons. When omitted, Flux uses the environment’s default locale.
• return_locales lets you restrict the locales returned in the payload. Without it, the API returns every locale stored in the environment.
• fallback_locales=true tells Flux to fill missing translations using the fallback chain configured in your workspace (for example, fr falling back to en).

GET https://7c9h4pwu.fxns.io/blog/articles?search_locale=fr&return_locales=fr,en&fallback_locales=true

{
  "_sys": {...},
  "data": {
    "title": {
      "fr": "Introduction à l'IA",
      "en": "Introduction to AI"
    },
    "summary": {
      "fr": "Résumé en français",
      "en": "English summary"
    }
  }
}

Pagination

List Resources returns cursor-based pagination with fully qualified URLs:

{
  "limit": 20,
  "next": "https://7c9h4pwu.fxns.io/blog/articles?limit=20&next=eyJjcmVh...NDJ9",
  "previous": null,
  "results": [...]
}

Follow the next or previous URL directly, or extract the cursor token. See Pagination for a full walkthrough.

Composite Folders

When querying composite folders (folders backed by multiple components):

• Provide component={component_key} whenever you filter on fields or use text search.
• If you request fields without a component, Flux returns 422 missed_component.

Example:

GET https://7c9h4pwu.fxns.io/landing-pages?component=hero-block&where__status__eq=published

Response Schema

Errors

For additional error codes, see Flux Errors.

Complete Example

GET https://7c9h4pwu.fxns.io/blog/articles\
?where__status__eq=published\
&where__category__in=tech,science\
&find_text__query=machine%20learning\
&find_text__fields=title,summary\
&find_text__threshold=0.85\
&sort=-_sys.created_at,title\
&populate=author\
&return_locales=en,fr\
&fallback_locales=true\
&limit=25

{
  "limit": 25,
  "next": "https://7c9h4pwu.fxns.io/blog/articles?limit=25&next=eyJjcmVh...MjV9",
  "previous": null,
  "results": [
    {
      "_sys": {
        "key": "hG9tL4nRmXwP",
        "created_at": "2024-01-15T10:30:00Z",
        "updated_at": "2024-01-15T10:30:00Z",
        "folder": "blog_articles"
      },
      "data": {
        "title": {
          "en": "Advanced Machine Learning Techniques",
          "fr": "Techniques avancées d'apprentissage automatique"
        },
        "status": "published",
        "category": "tech",
        "author": {
          "_sys": {...},
          "data": {"name": "Dr. John Smith"}
        }
      }
    }
  ]
}