Get Resource

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

Returns a single resource from a folder mapped to your Flux API. Use this endpoint when you know the exact folder path and resource key.

URL Pattern

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

Examples:

GET https://7c9h4pwu.fxns.io/blog/articles/dw2qC5qRwxuZ
GET https://7c9h4pwu.fxns.io/commerce/catalog/items/9d2hX6qPZmL0

Flux resolves folder_path using the router configuration you publish in Management API. Ensure the folder is connected via Connect Folder to API before calling this endpoint.

Query Parameters

Name
populate
Type
string
Description
Comma-separated list of reference fields to populate (author,category.parent). Maximum depth is three levels.
Name
return_locales
Type
string
Description
Comma-separated locales to include. Defaults to every locale enabled in the environment.
Name
fallback_locales
Type
boolean
Default
default:false
Description
When true, applies the environment’s fallback locale chain if a field is missing the requested translation.
Name
raw
Type
boolean
Default
default:false
Description
Returns data exactly as stored (no locale processing or reference formatting). Use only when building low-level tooling.

Basic Retrieval

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

Response

{
  "_sys": {
    "key": "dw2qC5qRwxuZ",
    "created_at": "2024-01-15T10:30:00Z",
    "updated_at": "2024-01-15T10:30:00Z",
    "folder": "aooxoscltikj"
  },
  "data": {
    "title": "Introduction to AI",
    "status": "published",
    "author": "mK8pL2nRvXwQ"
  }
}

Population

Populate replaces reference or relation IDs with the referenced documents (up to three levels deep).

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

Response with population

{
  "_sys": {...},
  "data": {
    "title": "Introduction to AI",
    "author": {
      "_sys": {...},
      "data": {
        "name": "John Smith",
        "company": {
          "_sys": {...},
          "data": { "name": "Tech Corp" }
        }
      }
    },
    "category": {
      "_sys": {...},
      "data": { "name": "Technology" }
    }
  }
}

Population follows the same rules as _search:

Only reference or relation fields can be populated.
Dot notation targets nested relationships (author.company.location).
Responses obey the population depth limit.

Localization

Use return_locales to restrict which translations appear in the response, and fallback_locales=true to automatically plug gaps using environment fallback rules.

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

Localized response

{
  "_sys": {...},
  "data": {
    "title": {
      "en": "Introduction to AI",
      "fr": "Introduction à l'IA"
    },
    "content": {
      "en": "This comprehensive guide explores artificial intelligence...",
      "fr": "Ce guide complet explore l'intelligence artificielle..."
    }
  }
}

Response Schema

Resource Object

Name
_sys
Type
object
Description
System metadata about the resource.
Name
data
Type
object
Description
Fields defined by the folder schema. Populated references contain nested _sys and data objects.

Errors

Status	error_code	When returned
401	`authentication_required`	Missing/invalid credentials or Secure timestamp outside ±15 minutes.
403	`access_denied`	Key is authenticated but lacks access to this API prefix or folder.
404	`resource_not_found`	Resource key does not exist, is unpublished, or fails strict-reference validation.
404	`route_not_found`	Folder path is not connected to the Flux API.
405	`action_not_allowed`	Folder is not configured for `get_one` in the API configuration (e.g., only search is allowed).
413	`max_response_size_exceeded`	Populated document exceeds the response size cap.
422	`validation_error`	Invalid query parameters (e.g., malformed `populate`).

List Resources — GET many resources from a folder.
Search — POST advanced filters, joins, and vector search.
Management API Resources — Create or manage resource content.