{"openapi":"3.1.0","info":{"title":"FastCMS API","description":"Open integration access to FastCMS pages, media, documents, and form submissions.\n\n**Access model:** reads are public. Selected writes are implemented but disabled unless the deployment configures `FASTSME_API_TOKEN`; write clients then send it as a bearer token.","contact":{"name":"FastSME","url":"https://fastsme.com/"},"license":{"name":"MIT"},"version":"1.0.0"},"servers":[{"url":"https://cms.fastsme.com/api","description":"Production"}],"paths":{"/":{"get":{"tags":["System"],"summary":"Api Index","operationId":"api_index__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Api Index  Get"}}}}}}},"/v1/health":{"get":{"tags":["System"],"summary":"Api Health","operationId":"api_health_v1_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HealthResponse"}}}}}}},"/v1/pages":{"get":{"tags":["Pages"],"summary":"List pages","description":"Structured CMS pages and publishing metadata.","operationId":"list_pages","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Case-insensitive text search","title":"Q"},"description":"Case-insensitive text search"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagesCollection"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Pages"],"summary":"Create Structured Page","description":"Create an unpublished page through FastCMS's page service.","operationId":"create_structured_page_v1_pages_post","security":[{"FastSME API token":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PageCreate"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/pages/{item_id}":{"get":{"tags":["Pages"],"summary":"Get one pages record","operationId":"get_pages","parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","title":"Item Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PagesResource"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/images":{"get":{"tags":["Images"],"summary":"List images","description":"Managed image assets and rendition metadata.","operationId":"list_images","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Case-insensitive text search","title":"Q"},"description":"Case-insensitive text search"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImagesCollection"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/images/{item_id}":{"get":{"tags":["Images"],"summary":"Get one images record","operationId":"get_images","parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","title":"Item Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ImagesResource"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/documents":{"get":{"tags":["Documents"],"summary":"List documents","description":"Managed downloadable documents.","operationId":"list_documents","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Case-insensitive text search","title":"Q"},"description":"Case-insensitive text search"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentsCollection"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/documents/{item_id}":{"get":{"tags":["Documents"],"summary":"Get one documents record","operationId":"get_documents","parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","title":"Item Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DocumentsResource"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/submissions":{"get":{"tags":["Form submissions"],"summary":"List form submissions","description":"Structured form submissions received by CMS pages.","operationId":"list_submissions","parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":200,"minimum":1,"default":50,"title":"Limit"}},{"name":"offset","in":"query","required":false,"schema":{"type":"integer","minimum":0,"default":0,"title":"Offset"}},{"name":"q","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Case-insensitive text search","title":"Q"},"description":"Case-insensitive text search"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormsubmissionsCollection"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/v1/submissions/{item_id}":{"get":{"tags":["Form submissions"],"summary":"Get one form submissions record","operationId":"get_submissions","parameters":[{"name":"item_id","in":"path","required":true,"schema":{"type":"string","title":"Item Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FormsubmissionsResource"}}}},"404":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"DocumentsCollection":{"properties":{"data":{"items":{"$ref":"#/components/schemas/DocumentsResource"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"DocumentsCollection"},"DocumentsResource":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"file_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Path"},"file_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Hash"},"file_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Size"},"file_ext":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Ext"},"collection_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Collection Id"},"uploaded_by_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Uploaded By Id"},"tags":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tags"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"}},"type":"object","title":"DocumentsResource"},"ErrorDetail":{"properties":{"code":{"type":"string","title":"Code"},"message":{"type":"string","title":"Message"},"details":{"additionalProperties":true,"type":"object","title":"Details"}},"type":"object","required":["code","message"],"title":"ErrorDetail","description":"Machine-readable API error."},"ErrorEnvelope":{"properties":{"error":{"$ref":"#/components/schemas/ErrorDetail"}},"type":"object","required":["error"],"title":"ErrorEnvelope","description":"Consistent error response envelope."},"FormsubmissionsCollection":{"properties":{"data":{"items":{"$ref":"#/components/schemas/FormsubmissionsResource"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"FormsubmissionsCollection"},"FormsubmissionsResource":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"page_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Page Id"},"data_json":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Data Json"},"submitted_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Submitted At"},"submitted_by_ip":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Submitted By Ip"}},"type":"object","title":"FormsubmissionsResource"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HealthResponse":{"properties":{"status":{"type":"string","title":"Status"},"product":{"type":"string","title":"Product"},"version":{"type":"string","title":"Version"},"writes_enabled":{"type":"boolean","title":"Writes Enabled"}},"type":"object","required":["status","product","version","writes_enabled"],"title":"HealthResponse","description":"API health response."},"ImagesCollection":{"properties":{"data":{"items":{"$ref":"#/components/schemas/ImagesResource"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"ImagesCollection"},"ImagesResource":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"file_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Path"},"file_hash":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"File Hash"},"file_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"File Size"},"width":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Width"},"height":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Height"},"alt_text":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Alt Text"},"focal_point_x":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Focal Point X"},"focal_point_y":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Focal Point Y"},"collection_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Collection Id"},"uploaded_by_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Uploaded By Id"},"tags":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tags"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"}},"type":"object","title":"ImagesResource"},"PageCreate":{"properties":{"parent_id":{"type":"integer","title":"Parent Id","description":"Parent page identifier"},"title":{"type":"string","maxLength":250,"minLength":1,"title":"Title"},"slug":{"type":"string","maxLength":250,"minLength":1,"pattern":"^[a-z0-9-]+$","title":"Slug"},"content_type":{"type":"string","title":"Content Type","default":"ContentPage"},"body_json":{"type":"string","title":"Body Json","default":"[]"},"extra_json":{"type":"string","title":"Extra Json","default":"{}"}},"type":"object","required":["parent_id","title","slug"],"title":"PageCreate"},"PagesCollection":{"properties":{"data":{"items":{"$ref":"#/components/schemas/PagesResource"},"type":"array","title":"Data"},"meta":{"$ref":"#/components/schemas/PaginationMeta"}},"type":"object","required":["data","meta"],"title":"PagesCollection"},"PagesResource":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug"},"content_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content Type"},"path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Path"},"depth":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Depth"},"numchild":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Numchild"},"url_path":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url Path"},"live":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Live"},"has_unpublished_changes":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Has Unpublished Changes"},"owner_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Owner Id"},"seo_title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Seo Title"},"search_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search Description"},"show_in_menus":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Show In Menus"},"first_published_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"First Published At"},"last_published_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Last Published At"},"go_live_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Go Live At"},"expire_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Expire At"},"expired":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Expired"},"locked":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Locked"},"locked_by_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Locked By Id"},"locked_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Locked At"},"body_json":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Body Json"},"extra_json":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Extra Json"},"created_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated At"}},"type":"object","title":"PagesResource"},"PaginationMeta":{"properties":{"total":{"type":"integer","title":"Total"},"limit":{"type":"integer","title":"Limit"},"offset":{"type":"integer","title":"Offset"}},"type":"object","required":["total","limit","offset"],"title":"PaginationMeta","description":"Offset pagination metadata."},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"},"input":{"title":"Input"},"ctx":{"type":"object","title":"Context"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}},"securitySchemes":{"FastSME API token":{"type":"http","description":"Selected writes require `Authorization: Bearer <token>`. Reads are public. Set FASTSME_API_TOKEN to enable writes.","scheme":"bearer"}}}}