Sites
Tags: content, sites
Endpoints
GET /mapping/{custom_domain}- MappingGET /{workspace_uuid}/{site_uuid}- Get Workspace Uuid Site UuidPOST /{workspace_uuid}/{site_uuid}/auth/send-email-code- Send Email CodePOST /{workspace_uuid}/{site_uuid}/auth/send-phone-code- Send Phone CodePOST /{workspace_uuid}/{site_uuid}/auth/verify- VerifyGET /{workspace_uuid}/{site_uuid}/files/{file_id}/contents/{filename}- ContentsGET /{workspace_uuid}/{site_uuid}/menu- MenuGET /{workspace_uuid}/{site_uuid}/pages/{page_slug_or_id}- PagesPOST /{workspace_uuid}/{site_uuid}/signup- Signup
Mapping
GET /api/v2/s/{site_uuid}/mapping/{custom_domain}
Description:
Website and content management
Get workspace_uuid and site_uuid for a custom domain.
Authorization: Requires scopes:
Parameters:
custom_domain(String)
Response: See SiteMappingResponse
Get Workspace Uuid Site Uuid
GET /api/v2/s/{site_uuid}/{workspace_uuid}/{site_uuid}
Description:
Website and content management
Get a specific site by ID.
Authentication: Requires workspace session
Parameters:
site_uuid(String)
Response: See SiteResponse
Send Email Code
POST /api/v2/s/{site_uuid}/{workspace_uuid}/{site_uuid}/auth/send-email-code
Description:
Website and content management
Send email verification code for site authentication (allows new signups if site.allow_signup=True).
Authentication: Requires workspace session
Parameters:
site_uuid(String)request- See SiteAuthEmailRequest
Response: See SendLoginCodeResponse
Send Phone Code
POST /api/v2/s/{site_uuid}/{workspace_uuid}/{site_uuid}/auth/send-phone-code
Description:
Website and content management
Send SMS verification code for site authentication (allows new signups if site.allow_signup=True).
Authentication: Requires workspace session
Parameters:
site_uuid(String)request- See SiteAuthPhoneRequest
Response: See SendLoginCodeResponse
Verify
POST /api/v2/s/{site_uuid}/{workspace_uuid}/{site_uuid}/auth/verify
Description:
Website and content management
Verify code and create account+member if needed for site with allow_signup=True.
Authentication: Requires workspace session
Parameters:
site_uuid(String)request- See SiteAuthVerifyRequest
Response: See SiteAuthVerifyResponse
Contents
GET /api/v2/s/{site_uuid}/{workspace_uuid}/{site_uuid}/files/{file_id}/contents/{filename}
Description:
Website and content management
Download file contents for site media with site-based access controls. This endpoint allows downloading site file contents with proper access control enforcement.
Authentication: Requires workspace session
Parameters:
site_uuid(String)file_id(Integer)filename(String)token(String)
Menu
GET /api/v2/s/{site_uuid}/{workspace_uuid}/{site_uuid}/menu
Description:
Website and content management
Get the complete menu tree for a site.
Authentication: Requires workspace session
Parameters:
site_uuid(String)
Response: See MenuTreeResponse
Pages
GET /api/v2/s/{site_uuid}/{workspace_uuid}/{site_uuid}/pages/{page_slug_or_id}
Description:
Website and content management
Get a specific page by its ID or slug within a site.
Supports locale-specific content via the locale query parameter. If the requested locale is not available, falls back to the page's primary locale.
Authentication: Requires workspace session
Parameters:
site_uuid(String)page_slug_or_id(String)locale(String)preview(Boolean)
Response: See RenderedPageResponse
Signup
POST /api/v2/s/{site_uuid}/{workspace_uuid}/{site_uuid}/signup
Description:
Website and content management
Sign up a logged-in user for a public site if signup is allowed.
Authentication: Requires workspace session
Parameters:
site_uuid(String)
Response: See SiteSignupResponse