GET /components

Παραθέτει περιλήψεις προσαρμοσμένων στοιχείων (σχήματα τύπου περιεχομένου) ενός ιστότοπου.

Παραθέτει περιλήψεις προσαρμοσμένων στοιχείων (σχήματα τύπου περιεχομένου) για έναν ιστότοπο, ταξινομημένες κατά όνομα. Επιστρέφονται μόνο προσαρμοσμένα σχήματα που ορίζονται από τον χρήστη.

Έλεγχος ταυτότητας: Κλειδί API (x-api-key header ή παράμετρος ερωτήματος api_key).

Παράμετροι ερωτήματος

Παράμετρος	Τύπος	Υποχρεωτικό	Σημειώσεις
`websiteId`	uuid	ναι	Πρέπει να είναι έγκυρο UUID. Δεν υπάρχει εναλλακτική `Host`/config σε αυτό το endpoint.
`state`	string	όχι	Φιλτράρει ανά κατάσταση κύκλου ζωής: `draft`, `active` ή `archived`.
`api_key`	string	όχι	Εναλλακτική του header `x-api-key`.

Απόκριση

Ένας πίνακας JSON με περιλήψεις στοιχείων:

[
  {
    "id": "...",
    "name": "post",
    "displayName": "Post",
    "description": "A documentation Post",
    "category": "Custom",
    "tags": [],
    "fields": [],
    "icon": null,
    "source": "custom",
    "version": 8,
    "routeSlugField": "title"
  }
]

source είναι πάντα "custom". displayName χρησιμοποιεί ως εναλλακτική το name και το category έχει προεπιλεγμένη τιμή "Custom" όταν δεν έχει οριστεί.

Παράδειγμα

curl '{CMS_API_URL}/components?websiteId=<uuid>&state=active' \
  -H 'x-api-key: <key>'

Σφάλματα

400 — λείπει ή δεν είναι έγκυρο το websiteId
401 — μη έγκυρο κλειδί API

Previous‹GET /blocks/generated NextGET /components/{name}›

Παράμετροι ερωτήματος

Παράμετρος

Τύπος

Υποχρεωτικό

Σημειώσεις

websiteId

uuid

ναι

Πρέπει να είναι έγκυρο UUID. Δεν υπάρχει εναλλακτική Host/config σε αυτό το endpoint.

state

string

όχι

Φιλτράρει ανά κατάσταση κύκλου ζωής: draft, active ή archived.

api_key

string

όχι

Εναλλακτική του header x-api-key.

Απόκριση

Ένας πίνακας JSON με περιλήψεις στοιχείων:

[
  {
    "id": "...",
    "name": "post",
    "displayName": "Post",
    "description": "A documentation Post",
    "category": "Custom",
    "tags": [],
    "fields": [],
    "icon": null,
    "source": "custom",
    "version": 8,
    "routeSlugField": "title"
  }
]