OpenAPI spec
Generated OpenAPI description of the HeadlessWP Pro endpoint surface.
Download or copy the latest published YAML spec.
Download YAMLOPENAPI SPEC (YAML)
Generated from the docs bundle. Replace the server URL(s) before importing.
openapi: 3.0.3
info:
title: HeadlessWP Pro API
version: 1.0.0
description: OpenAPI spec generated from the documentation bundle. Best-effort mirror of documented /wp-json/headlesswp/v1
endpoints, envelopes, and errors.
servers:
- url: https://YOUR_SITE.com
description: Replace with your environment
tags:
- name: Account
- name: Admin
- name: Affiliate
- name: Affiliates
- name: Auth
- name: Billing
- name: Bookings
- name: Capabilities
- name: Content
- name: Edd
- name: Forms
- name: Frontend
- name: Give
- name: Ld
- name: Me
- name: Media
- name: Memberships
- name: Meta
- name: Mp
- name: Orders
- name: Store
- name: Subscriptions
- name: Test-validation
- name: Webhooks
paths:
/wp-json/headlesswp/v1/account/deactivate:
post:
tags:
- Account
summary: Deactivate account
operationId: account_deactivate_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AccountLifecycleController::deactivate (src/Http/Controllers/AccountLifecycleController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
security:
- apiKeyAuth: []
- bearerAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
status: ok
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'401':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id001
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id001
'429':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id001
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id001
/wp-json/headlesswp/v1/admin/alerts/dismiss:
post:
tags:
- Admin
summary: Admin alert dismiss
operationId: admin_alerts_dismiss_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AdminAlertsController::dismiss (src/Http/Controllers/AdminAlertsController.php)
Visibility: internal
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
security:
- apiKeyAuth: []
- bearerAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
status: ok
id: 123
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/admin/alerts/refresh:
post:
tags:
- Admin
summary: Admin alert refresh
operationId: admin_alerts_refresh_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AdminAlertsController::refresh (src/Http/Controllers/AdminAlertsController.php)
Visibility: internal
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
security:
- apiKeyAuth: []
- bearerAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
status: ok
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/admin/alerts/reset:
post:
tags:
- Admin
summary: Admin alert reset
operationId: admin_alerts_reset_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AdminAlertsController::reset (src/Http/Controllers/AdminAlertsController.php)
Visibility: internal
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
security:
- apiKeyAuth: []
- bearerAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
status: ok
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/admin/config/export:
get:
tags:
- Admin
summary: Admin config export
operationId: admin_config_export_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AdminConfigExportImportController::exportConfig (src/Http/Controllers/AdminConfigExportImportController.php)
Visibility: internal'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
config: {}
core: <value>
endpoints: []
extensions: []
exportMeta: <value>
exportedAt: <value>
environment: <value>
version: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/admin/config/import:
post:
tags:
- Admin
summary: Admin config import
operationId: admin_config_import_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AdminConfigExportImportController::importConfig (src/Http/Controllers/AdminConfigExportImportController.php)
Visibility: internal
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
dryRun: <value>
appliedCounts: []
warnings: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/admin/diagnostics:
get:
tags:
- Admin
summary: Admin diagnostics
operationId: admin_diagnostics_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AdminDiagnosticsController::getDiagnostics (src/Http/Controllers/AdminDiagnosticsController.php)
Visibility: internal'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
environment: <value>
phpVersion: <value>
wpVersion: <value>
siteUrl: https://example.com
mode: <value>
integrations: []
woocommerce: <value>
restrictContentPro: <value>
affiliateWp: <value>
extensions: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/admin/identity/metrics:
get:
tags:
- Admin
summary: Admin identity metrics
operationId: admin_identityMetrics_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AdminIdentityMetricsController::index (src/Http/Controllers/AdminIdentityMetricsController.php)
Visibility: internal'
security:
- apiKeyAuth: []
- bearerAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
window: <value>
last30DaysTotals: []
trends: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/admin/nonces:
get:
tags:
- Admin
summary: Admin nonces
operationId: admin_nonces_get_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: NonceController::getAdminNonces (src/Http/Controllers/NonceController.php)
Visibility: internal'
security:
- apiKeyAuth: []
- bearerAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
actions: []
fields: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/admin/self-test:
get:
tags:
- Admin
summary: Admin self-test
operationId: admin_selfTest_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: SelfTestController::run (src/Http/Controllers/SelfTestController.php)
Visibility: internal'
security:
- apiKeyAuth: []
- bearerAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
environment: <value>
dependencies: []
pluginChecks: []
license: <value>
p2: <value>
p3: <value>
identityMetrics: []
serviceAccounts: []
securityEvents: []
p4: <value>
configuration: <value>
bundling: <value>
alerts: []
plugins: []
extensions: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/admin/service-accounts:
post:
tags:
- Admin
summary: Admin service account create
operationId: admin_serviceAccounts_create_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AdminServiceAccountsController::createServiceAccount (src/Http/Controllers/AdminServiceAccountsController.php)
Visibility: internal
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
security:
- apiKeyAuth: []
- bearerAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
serviceAccount: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
get:
tags:
- Admin
summary: Admin service account list
operationId: admin_serviceAccounts_list_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AdminServiceAccountsController::listServiceAccounts (src/Http/Controllers/AdminServiceAccountsController.php)
Visibility: internal'
security:
- apiKeyAuth: []
- bearerAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
serviceAccounts: []
featureEnabled: true
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/admin/service-accounts/{userId}/keys:
get:
tags:
- Admin
summary: Admin service account keys
operationId: admin_serviceAccounts_keys_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AdminServiceAccountsController::listKeys (src/Http/Controllers/AdminServiceAccountsController.php)
Visibility: internal'
parameters:
- name: userId
in: path
required: true
schema:
type: integer
description: Path parameter `userId`.
security:
- apiKeyAuth: []
- bearerAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
serviceAccount: <value>
keys: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
post:
tags:
- Admin
summary: Admin service account key create
operationId: admin_serviceAccounts_keys_create_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AdminServiceAccountsController::createKey (src/Http/Controllers/AdminServiceAccountsController.php)
Visibility: internal
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
parameters:
- name: userId
in: path
required: true
schema:
type: integer
description: Path parameter `userId`.
security:
- apiKeyAuth: []
- bearerAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
apiKey: <value>
token: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/admin/service-accounts/{userId}/keys/{keyId}/regenerate:
post:
tags:
- Admin
summary: Admin service account key regenerate
operationId: admin_serviceAccounts_keys_regenerate_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AdminServiceAccountsController::regenerateKey (src/Http/Controllers/AdminServiceAccountsController.php)
Visibility: internal
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
parameters:
- name: userId
in: path
required: true
schema:
type: integer
description: Path parameter `userId`.
- name: keyId
in: path
required: true
schema:
type: integer
description: Path parameter `keyId`.
security:
- apiKeyAuth: []
- bearerAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
apiKey: <value>
token: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/admin/service-accounts/{userId}/keys/{keyId}/revoke:
post:
tags:
- Admin
summary: Admin service account key revoke
operationId: admin_serviceAccounts_keys_revoke_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AdminServiceAccountsController::revokeKey (src/Http/Controllers/AdminServiceAccountsController.php)
Visibility: internal
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
parameters:
- name: userId
in: path
required: true
schema:
type: integer
description: Path parameter `userId`.
- name: keyId
in: path
required: true
schema:
type: integer
description: Path parameter `keyId`.
security:
- apiKeyAuth: []
- bearerAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
revoked: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/admin/service-accounts/{userId}/revoke:
post:
tags:
- Admin
summary: Admin service account revoke
operationId: admin_serviceAccounts_revoke_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AdminServiceAccountsController::revokeServiceAccount (src/Http/Controllers/AdminServiceAccountsController.php)
Visibility: internal
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
parameters:
- name: userId
in: path
required: true
schema:
type: integer
description: Path parameter `userId`.
security:
- apiKeyAuth: []
- bearerAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
revoked: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/admin/users/{userId}/entitlements:
get:
tags:
- Admin
summary: Admin user entitlements
operationId: admin_userEntitlements_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AdminUserEntitlementsController::getUserEntitlements (src/Http/Controllers/AdminUserEntitlementsController.php)
Visibility: internal'
parameters:
- name: userId
in: path
required: true
schema:
type: integer
description: Path parameter `userId`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
user: {}
entitlements: []
accessFlags: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/admin/users/{userId}/entitlements/refresh:
post:
tags:
- Admin
summary: Refresh user entitlements
operationId: admin_userEntitlements_refresh_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AdminUserEntitlementsController::refreshUserEntitlements (src/Http/Controllers/AdminUserEntitlementsController.php)
Visibility: internal
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
parameters:
- name: userId
in: path
required: true
schema:
type: integer
description: Path parameter `userId`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
userId: 123
entitlements: []
accessFlags: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/affiliate/track:
post:
tags:
- Affiliate
summary: Affiliate track
operationId: affiliate_track_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AffiliateTrackController::track (src/Http/Controllers/AffiliateTrackController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
ref: <value>
campaign: <value>
ttlSeconds: []
expiresAt: <value>
flags: []
domain: <value>
path: <value>
secure: <value>
httpOnly: <value>
sameSite: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id002
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'422':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id002
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id002
/wp-json/headlesswp/v1/auth/email-exists:
post:
tags:
- Auth
summary: Email exists helper
operationId: auth_emailExists_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: EmailExistsController::exists (src/Http/Controllers/EmailExistsController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
exists: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id003
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'422':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id003
'429':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id003
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id003
/wp-json/headlesswp/v1/auth/login:
post:
tags:
- Auth
summary: Login
operationId: auth_login_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AuthController::login (src/Http/Controllers/AuthController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
user: {}
flags: []
entitlements: []
next: <string>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'400':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id004
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'401':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id004
'429':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id004
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id004
/wp-json/headlesswp/v1/auth/logout:
post:
tags:
- Auth
summary: Logout
operationId: auth_logout_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AuthController::logout (src/Http/Controllers/AuthController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
loggedOut: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'401':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id005
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id005
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id005
/wp-json/headlesswp/v1/auth/password/forgot:
post:
tags:
- Auth
summary: Password reset request
operationId: auth_password_forgot_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: PasswordResetController::forgot (src/Http/Controllers/PasswordResetController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id006
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'422':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id006
'429':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id006
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id006
/wp-json/headlesswp/v1/auth/password/reset:
post:
tags:
- Auth
summary: Password reset
operationId: auth_password_reset_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: PasswordResetController::reset (src/Http/Controllers/PasswordResetController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
user: {}
flags: []
entitlements: []
next: <string>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'400':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id007
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id007
'422':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id007
'429':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id007
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id007
/wp-json/headlesswp/v1/auth/password/set:
post:
tags:
- Auth
summary: Password setup
operationId: auth_password_set_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: PasswordResetController::setPassword (src/Http/Controllers/PasswordResetController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
status: ok
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'400':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id008
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id008
'422':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id008
'429':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id008
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id008
/wp-json/headlesswp/v1/auth/password/set/validate:
post:
tags:
- Auth
summary: Password setup validate
operationId: auth_password_set_validate_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: PasswordResetController::validateSetPassword (src/Http/Controllers/PasswordResetController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
status: ok
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id009
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'422':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id009
'429':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id009
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id009
/wp-json/headlesswp/v1/auth/register:
post:
tags:
- Auth
summary: Register
operationId: auth_register_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AuthController::register (src/Http/Controllers/AuthController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
user: {}
flags: []
entitlements: []
registrationStatus: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'400':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id010
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id010
'422':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id010
'429':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id010
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id010
/wp-json/headlesswp/v1/auth/sso/callback:
post:
tags:
- Auth
summary: SSO callback
operationId: auth_sso_callback_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: SsoCallbackController::handleCallback (src/Http/Controllers/SsoCallbackController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
user: {}
flags: []
entitlements: []
next: <string>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'400':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id011
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id011
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id011
/wp-json/headlesswp/v1/auth/sso/providers:
get:
tags:
- Auth
summary: SSO provider discovery
operationId: auth_sso_providers_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: SsoProvidersController::getProviders (src/Http/Controllers/SsoProvidersController.php)
Visibility: public'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
enabled: true
providers: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/auth/token:
post:
tags:
- Auth
summary: Issue token
operationId: auth_token_issue_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: TokenController::issue (src/Http/Controllers/TokenController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
token: <value>
expiresAt: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'401':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id012
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id012
'501':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id012
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id012
/wp-json/headlesswp/v1/auth/token/revoke:
post:
tags:
- Auth
summary: Revoke token
operationId: auth_token_revoke_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: TokenController::revoke (src/Http/Controllers/TokenController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
revoked: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'400':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id013
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'401':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id013
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id013
'501':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id013
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id013
/wp-json/headlesswp/v1/auth/verify-email:
post:
tags:
- Auth
summary: Verify email
operationId: auth_verifyEmail_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: EmailVerificationController::verify (src/Http/Controllers/EmailVerificationController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
status: ok
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'400':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id014
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id014
'422':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id014
'429':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id014
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id014
/wp-json/headlesswp/v1/billing/portal-session:
post:
tags:
- Billing
summary: Billing portal session
operationId: billing_portalSession_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: BillingPortalController::createSession (src/Http/Controllers/BillingPortalController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
url: https://example.com
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'400':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id015
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'401':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id015
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id015
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id015
/wp-json/headlesswp/v1/capabilities:
get:
tags:
- Capabilities
summary: Capabilities
operationId: capabilities_get_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: CapabilitiesController::getCapabilities (src/Http/Controllers/CapabilitiesController.php)
Visibility: public'
security:
- apiKeyAuth: []
- bearerAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
versions: []
features: []
requiredEndpoints: []
publicEndpoints: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/config/app:
get:
tags:
- Meta
summary: Config app
operationId: config_app_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: ConfigController::getAppConfig (src/Http/Controllers/ConfigController.php)
Visibility: public'
security:
- apiKeyAuth: []
- bearerAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
app: <value>
name: <value>
env: <value>
version: <value>
features: []
security: <value>
csrfHeader: <value>
loginRateLimit: <value>
bucket: <value>
limit: <value>
windowSeconds: []
uiHints: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/content/funnel:
get:
tags:
- Content
summary: Funnel content snapshot
operationId: content_funnel_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: ContentFunnelController::getFunnelSnapshot (src/Http/Controllers/ContentFunnelController.php)
Visibility: public'
parameters:
- name: page
in: query
required: false
schema:
type: integer
description: Query parameter `page`.
- name: perPage
in: query
required: false
schema:
type: integer
description: Query parameter `perPage`.
- name: purpose
in: query
required: false
schema:
type: string
description: Query parameter `purpose`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
purpose: <value>
pages: []
tiers: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'400':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id016
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id016
/wp-json/headlesswp/v1/content/menus/{location}:
get:
tags:
- Content
summary: Content menu
operationId: content_menus_byLocation_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: ContentMenusController::getMenu (src/Http/Controllers/ContentMenusController.php)
Visibility: public'
parameters:
- name: location
in: path
required: true
schema:
type: string
description: Path parameter `location`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
menu: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'400':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id017
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'404':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id017
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id017
/wp-json/headlesswp/v1/content/pages/{idOrSlug}:
get:
tags:
- Content
summary: Content page detail
operationId: content_pages_detail_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: ContentPagesController::getPage (src/Http/Controllers/ContentPagesController.php)
Visibility: public'
parameters:
- name: idOrSlug
in: path
required: true
schema:
type: string
description: Path parameter `idOrSlug`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
page: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'404':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id018
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id018
/wp-json/headlesswp/v1/content/pages:
get:
tags:
- Content
summary: Content pages
operationId: content_pages_index_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: ContentPagesController::listPages (src/Http/Controllers/ContentPagesController.php)
Visibility: public'
parameters:
- name: page
in: query
required: false
schema:
type: integer
description: Query parameter `page`.
- name: perPage
in: query
required: false
schema:
type: integer
description: Query parameter `perPage`.
- name: purpose
in: query
required: false
schema:
type: string
description: Query parameter `purpose`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'400':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id019
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id019
/wp-json/headlesswp/v1/frontend/bootstrap:
get:
tags:
- Frontend
summary: Frontend bootstrap
operationId: frontend_bootstrap_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: FrontendBootstrapController::getBootstrap (src/Http/Controllers/FrontendBootstrapController.php)
Visibility: public'
security:
- apiKeyAuth: []
- bearerAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/health:
get:
tags:
- Meta
summary: Health
operationId: health_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: HeadlessWPPro\Http\Routes\Routes::getHealth (src/Http/Routes/Routes.php)
Visibility: public'
security:
- apiKeyAuth: []
- bearerAuth: []
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
status: ok
version: <value>
env: <value>
wpVersion: <value>
phpVersion: <value>
dependencies: []
buildId: 123
buildFlavor: <value>
nonceBootstrapStrategy: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/admin/logs/{logId}:
get:
tags:
- Admin
summary: Admin log detail
operationId: logs_detail_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AdminLogsController::getLog (src/Http/Controllers/AdminLogsController.php)
Visibility: internal'
parameters:
- name: logId
in: path
required: true
schema:
type: integer
description: Path parameter `logId`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
log: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/admin/logs:
get:
tags:
- Admin
summary: Admin logs
operationId: logs_list_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AdminLogsController::listLogs (src/Http/Controllers/AdminLogsController.php)
Visibility: internal'
parameters:
- name: code
in: query
required: false
schema:
type: string
description: Query parameter `code`.
- name: level
in: query
required: false
schema:
type: string
description: Query parameter `level`.
- name: page
in: query
required: false
schema:
type: integer
description: Query parameter `page`.
- name: perPage
in: query
required: false
schema:
type: integer
description: Query parameter `perPage`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
logs: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/admin/logs/summary:
get:
tags:
- Admin
summary: Admin log summary
operationId: logs_summary_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: AdminLogsController::getSummary (src/Http/Controllers/AdminLogsController.php)
Visibility: internal'
parameters:
- name: code
in: query
required: false
schema:
type: string
description: Query parameter `code`.
- name: level
in: query
required: false
schema:
type: string
description: Query parameter `level`.
- name: page
in: query
required: false
schema:
type: integer
description: Query parameter `page`.
- name: perPage
in: query
required: false
schema:
type: integer
description: Query parameter `perPage`.
- name: security
in: query
required: false
schema:
type: string
description: Query parameter `security`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
summary: {}
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/me:
get:
tags:
- Me
summary: Current user
operationId: me_get_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: MeController::getProfile (src/Http/Controllers/MeController.php)
Visibility: public'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'401':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id020
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id020
/wp-json/headlesswp/v1/me/profile:
patch:
tags:
- Me
summary: Update profile
operationId: me_updateProfile_patch
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: MeController::updateProfile (src/Http/Controllers/MeController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
user: {}
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'401':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id021
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id021
'422':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id021
'500':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id021
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id021
/wp-json/headlesswp/v1/media/download/{resourceKey}:
get:
tags:
- Media
summary: Protected media download
operationId: media_download_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: MediaDownloadsController::getDownload (src/Http/Controllers/MediaDownloadsController.php)
Visibility: public'
parameters:
- name: resourceKey
in: path
required: true
schema:
type: string
description: Path parameter `resourceKey`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
downloadUrl: https://example.com
expiresAt: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'401':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id022
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id022
'404':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id022
'422':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id022
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id022
/wp-json/headlesswp/v1/media/stream/{token}:
get:
tags:
- Media
summary: Protected media stream
operationId: media_stream_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: MediaDownloadsController::streamDownload (src/Http/Controllers/MediaDownloadsController.php)
Visibility: public'
parameters:
- name: token
in: path
required: true
schema:
type: string
description: Path parameter `token`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'401':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id023
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id023
'404':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id023
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id023
/wp-json/headlesswp/v1/nonce:
get:
tags:
- Meta
summary: Nonce
operationId: nonce_get_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: NonceController::getNonce (src/Http/Controllers/NonceController.php)
Visibility: public'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
nonce: <value>
headerName: <value>
user: {}
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/me/sessions:
get:
tags:
- Me
summary: Session listing
operationId: sessions_index_get
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: SessionController::listSessions (src/Http/Controllers/SessionController.php)
Visibility: public'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
sessions: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'401':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id024
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id024
/wp-json/headlesswp/v1/me/sessions/revoke:
post:
tags:
- Me
summary: Revoke sessions
operationId: sessions_revoke_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: SessionController::revokeSessions (src/Http/Controllers/SessionController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
'401':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
/wp-json/headlesswp/v1/test-validation:
post:
tags:
- Test-validation
summary: Validator smoke test (non-production only)
operationId: test_validation_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: TestValidationRoute::__invoke (src/Http/Routes/TestValidationRoute.php)
Visibility: dev
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).
Warning: Marked dev-only in docs; do not expose in production.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
revokedCount: <value>
remainingCount: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'422':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id025
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id025
/wp-json/headlesswp/v1/webhooks/stripe:
post:
tags:
- Webhooks
summary: Stripe webhook
operationId: webhooks_stripe_post
description: 'Source: 11_API_REFERENCE_CORE.txt
Handler: StripeWebhookController::handle (src/Http/Controllers/StripeWebhookController.php)
Visibility: internal
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
received: <value>
eventId: 123
eventType: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/orders:
get:
tags:
- Orders
summary: Woo orders
operationId: woo_orders_list_get
description: 'Source: 12_API_REFERENCE_WOOCOMMERCE.txt
Handler: OrdersController::listUserOrders (src/Http/Controllers/OrdersController.php)
Visibility: public'
parameters:
- name: page
in: query
required: false
schema:
type: integer
description: Query parameter `page`.
- name: perPage
in: query
required: false
schema:
type: integer
description: Query parameter `perPage`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
orders: []
pagination:
page: 1
perPage: 10
total: 0
hasMore: false
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'401':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id026
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id026
/wp-json/headlesswp/v1/store/checkout-session:
post:
tags:
- Store
summary: Checkout session
operationId: woo_store_checkoutSession_post
description: 'Source: 12_API_REFERENCE_WOOCOMMERCE.txt
Handler: CheckoutSessionController::createSession (src/Http/Controllers/CheckoutSessionController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/AnyValue'
example:
productId: 123
quantity: 1
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'400':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id027
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id027
'409':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id027
'422':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id027
'429':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id027
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id027
/wp-json/headlesswp/v1/store/offers:
get:
tags:
- Store
summary: Storefront offers
operationId: woo_store_offers_list_get
description: 'Source: 12_API_REFERENCE_WOOCOMMERCE.txt
Handler: StorefrontController::listOffers (src/Http/Controllers/StorefrontController.php)
Visibility: public'
parameters:
- name: category
in: query
required: false
schema:
type: string
description: Query parameter `category`.
- name: page
in: query
required: false
schema:
type: integer
description: Query parameter `page`.
- name: perPage
in: query
required: false
schema:
type: integer
description: Query parameter `perPage`.
- name: search
in: query
required: false
schema:
type: string
description: Query parameter `search`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'400':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id028
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'503':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id028
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id028
/wp-json/headlesswp/v1/store/products/{productIdOrSlug}:
get:
tags:
- Store
summary: Storefront product detail
operationId: woo_store_products_detail_get
description: 'Source: 12_API_REFERENCE_WOOCOMMERCE.txt
Handler: StorefrontController::getProduct (src/Http/Controllers/StorefrontController.php)
Visibility: public'
parameters:
- name: productIdOrSlug
in: path
required: true
schema:
type: string
description: Path parameter `productIdOrSlug`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
product: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'404':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id029
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'503':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id029
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id029
/wp-json/headlesswp/v1/store/products:
get:
tags:
- Store
summary: Storefront products
operationId: woo_store_products_list_get
description: 'Source: 12_API_REFERENCE_WOOCOMMERCE.txt
Handler: StorefrontController::listProducts (src/Http/Controllers/StorefrontController.php)
Visibility: public'
parameters:
- name: category
in: query
required: false
schema:
type: string
description: Query parameter `category`.
- name: page
in: query
required: false
schema:
type: integer
description: Query parameter `page`.
- name: perPage
in: query
required: false
schema:
type: integer
description: Query parameter `perPage`.
- name: search
in: query
required: false
schema:
type: string
description: Query parameter `search`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'400':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id030
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'503':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id030
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id030
/wp-json/headlesswp/v1/store/wc/cart:
get:
tags:
- Store
summary: Store API cart
operationId: woo_storeApi_cart_get
description: 'Source: 12_API_REFERENCE_WOOCOMMERCE.txt
Handler: StoreApiBridgeController::getCart (src/Http/Controllers/StoreApiBridgeController.php)
Visibility: public'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/store/wc/cart/add-item:
post:
tags:
- Store
summary: Store API cart add item
operationId: woo_storeApi_cart_addItem_post
description: 'Source: 12_API_REFERENCE_WOOCOMMERCE.txt
Handler: StoreApiBridgeController::addCartItem (src/Http/Controllers/StoreApiBridgeController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id031
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id031
/wp-json/headlesswp/v1/store/wc/cart/apply-coupon:
post:
tags:
- Store
summary: Store API cart apply coupon
operationId: woo_storeApi_cart_applyCoupon_post
description: 'Source: 12_API_REFERENCE_WOOCOMMERCE.txt
Handler: StoreApiBridgeController::applyCoupon (src/Http/Controllers/StoreApiBridgeController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'400':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id032
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id032
'429':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id032
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id032
/wp-json/headlesswp/v1/store/wc/cart/remove-coupon:
post:
tags:
- Store
summary: Store API cart remove coupon
operationId: woo_storeApi_cart_removeCoupon_post
description: 'Source: 12_API_REFERENCE_WOOCOMMERCE.txt
Handler: StoreApiBridgeController::removeCoupon (src/Http/Controllers/StoreApiBridgeController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id033
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id033
/wp-json/headlesswp/v1/store/wc/cart/remove-item:
post:
tags:
- Store
summary: Store API cart remove item
operationId: woo_storeApi_cart_removeItem_post
description: 'Source: 12_API_REFERENCE_WOOCOMMERCE.txt
Handler: StoreApiBridgeController::removeCartItem (src/Http/Controllers/StoreApiBridgeController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id034
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id034
/wp-json/headlesswp/v1/store/wc/cart/select-shipping-rate:
post:
tags:
- Store
summary: Store API cart select shipping rate
operationId: woo_storeApi_cart_selectShippingRate_post
description: 'Source: 12_API_REFERENCE_WOOCOMMERCE.txt
Handler: StoreApiBridgeController::selectShippingRate (src/Http/Controllers/StoreApiBridgeController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id035
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id035
/wp-json/headlesswp/v1/store/wc/cart/shipping-rates:
get:
tags:
- Store
summary: Store API cart shipping rates
operationId: woo_storeApi_cart_shippingRates_get
description: 'Source: 12_API_REFERENCE_WOOCOMMERCE.txt
Handler: StoreApiBridgeController::getShippingRates (src/Http/Controllers/StoreApiBridgeController.php)
Visibility: public'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/store/wc/cart/update-customer:
post:
tags:
- Store
summary: Store API cart update customer
operationId: woo_storeApi_cart_updateCustomer_post
description: 'Source: 12_API_REFERENCE_WOOCOMMERCE.txt
Handler: StoreApiBridgeController::updateCustomer (src/Http/Controllers/StoreApiBridgeController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id036
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id036
/wp-json/headlesswp/v1/store/wc/cart/update-item:
post:
tags:
- Store
summary: Store API cart update item
operationId: woo_storeApi_cart_updateItem_post
description: 'Source: 12_API_REFERENCE_WOOCOMMERCE.txt
Handler: StoreApiBridgeController::updateCartItem (src/Http/Controllers/StoreApiBridgeController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id037
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id037
/wp-json/headlesswp/v1/store/wc/checkout:
get:
tags:
- Store
summary: Store API checkout
operationId: woo_storeApi_checkout_get
description: 'Source: 12_API_REFERENCE_WOOCOMMERCE.txt
Handler: StoreApiBridgeController::getCheckout (src/Http/Controllers/StoreApiBridgeController.php)
Visibility: public'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
post:
tags:
- Store
summary: Store API checkout submit
operationId: woo_storeApi_checkout_submit_post
description: 'Source: 12_API_REFERENCE_WOOCOMMERCE.txt
Handler: StoreApiBridgeController::submitCheckout (src/Http/Controllers/StoreApiBridgeController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id038
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id038
/wp-json/headlesswp/v1/store/wc/payment-methods:
get:
tags:
- Store
summary: Store API payment methods
operationId: woo_storeApi_paymentMethods_get
description: 'Source: 12_API_REFERENCE_WOOCOMMERCE.txt
Handler: StoreApiBridgeController::getPaymentMethods (src/Http/Controllers/StoreApiBridgeController.php)
Visibility: public'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/subscriptions:
get:
tags:
- Subscriptions
summary: Woo subscriptions
operationId: woo_subscriptions_list_get
description: 'Source: 12_API_REFERENCE_WOOCOMMERCE.txt
Handler: SubscriptionsController::listUserSubscriptions (src/Http/Controllers/SubscriptionsController.php)
Visibility: public'
parameters:
- name: page
in: query
required: false
schema:
type: integer
description: Query parameter `page`.
- name: perPage
in: query
required: false
schema:
type: integer
description: Query parameter `perPage`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
subscriptions: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'401':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id039
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id039
/wp-json/headlesswp/v1/affiliates/accept-terms:
post:
tags:
- Affiliates
summary: Affiliate accept terms
operationId: affiliates_acceptTerms_post
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: AffiliatesController::acceptTerms (src/Http/Controllers/AffiliatesController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
version: <value>
acceptedAtUtc: <value>
currentTermsVersion: <value>
termsAcceptedVersion: <value>
termsAcceptedAtUtc: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'401':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id040
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id040
'409':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id040
'422':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id040
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id040
/wp-json/headlesswp/v1/affiliates/apply:
post:
tags:
- Affiliates
summary: Affiliate apply
operationId: affiliates_apply_post
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: AffiliateApplicationsController::apply (src/Http/Controllers/AffiliateApplicationsController.php)
Visibility: public
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
affiliate: <value>
id: 123
userId: 123
email: <value>
firstName: <value>
lastName: <value>
website: <value>
promotionMethod: <value>
status: ok
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'401':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id041
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'403':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id041
'422':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id041
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id041
/wp-json/headlesswp/v1/affiliates/me:
get:
tags:
- Affiliates
summary: Affiliate profile
operationId: affiliates_me_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: AffiliatesController::getCurrentAffiliate (src/Http/Controllers/AffiliatesController.php)
Visibility: public'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
affiliate: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'401':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id042
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id042
/wp-json/headlesswp/v1/affiliates/referrals:
get:
tags:
- Affiliates
summary: Affiliate referrals
operationId: affiliates_referrals_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: AffiliatesController::getReferrals (src/Http/Controllers/AffiliatesController.php)
Visibility: public'
parameters:
- name: cursor
in: query
required: false
schema:
type: string
description: Query parameter `cursor`.
- name: limit
in: query
required: false
schema:
type: integer
description: Query parameter `limit`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'401':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id043
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'404':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id043
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id043
/wp-json/headlesswp/v1/affiliates/stats:
get:
tags:
- Affiliates
summary: Affiliate stats
operationId: affiliates_stats_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: AffiliatesController::getStats (src/Http/Controllers/AffiliatesController.php)
Visibility: public'
parameters:
- name: range
in: query
required: false
schema:
type: string
description: Query parameter `range`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
<varies>: <see notes>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'401':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: &id044
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
'404':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id044
'422':
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id044
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example: *id044
/wp-json/headlesswp/v1/affiliates/terms:
get:
tags:
- Affiliates
summary: Affiliate terms
operationId: affiliates_terms_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: AffiliatesController::getTerms (src/Http/Controllers/AffiliatesController.php)
Visibility: public'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
termsEnabled: <value>
termsContentPresent: <value>
contentFormat: <value>
currentTermsVersion: <value>
termsContent: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/bookings/availability:
get:
tags:
- Bookings
summary: Booking availability
operationId: bookings_availability_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: FluentBookingController::getAvailability (src/Http/Controllers/FluentBookingController.php)
Visibility: dev
Warning: Marked dev-only in docs; do not expose in production.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
availability: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/bookings/{bookingId}/cancel:
post:
tags:
- Bookings
summary: Cancel booking
operationId: bookings_cancel_post
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: FluentBookingController::cancelBooking (src/Http/Controllers/FluentBookingController.php)
Visibility: dev
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).
Warning: Marked dev-only in docs; do not expose in production.'
parameters:
- name: bookingId
in: path
required: true
schema:
type: string
description: Path parameter `bookingId`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
booking: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/bookings/catalog:
get:
tags:
- Bookings
summary: Bookings catalog
operationId: bookings_catalog_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: FluentBookingController::getCatalog (src/Http/Controllers/FluentBookingController.php)
Visibility: dev
Warning: Marked dev-only in docs; do not expose in production.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
catalog: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/bookings:
post:
tags:
- Bookings
summary: Create booking
operationId: bookings_create_post
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: FluentBookingController::createBooking (src/Http/Controllers/FluentBookingController.php)
Visibility: dev
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).
Warning: Marked dev-only in docs; do not expose in production.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
booking: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/bookings/{bookingId}:
get:
tags:
- Bookings
summary: Booking detail
operationId: bookings_detail_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: FluentBookingController::getBooking (src/Http/Controllers/FluentBookingController.php)
Visibility: dev
Warning: Marked dev-only in docs; do not expose in production.'
parameters:
- name: bookingId
in: path
required: true
schema:
type: string
description: Path parameter `bookingId`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
booking: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/bookings/provider:
get:
tags:
- Bookings
summary: Bookings provider
operationId: bookings_provider_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: FluentBookingController::getProvider (src/Http/Controllers/FluentBookingController.php)
Visibility: dev
Warning: Marked dev-only in docs; do not expose in production.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
provider: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/bookings/{bookingId}/reschedule:
post:
tags:
- Bookings
summary: Reschedule booking
operationId: bookings_reschedule_post
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: FluentBookingController::rescheduleBooking (src/Http/Controllers/FluentBookingController.php)
Visibility: dev
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).
Warning: Marked dev-only in docs; do not expose in production.'
parameters:
- name: bookingId
in: path
required: true
schema:
type: string
description: Path parameter `bookingId`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
booking: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/bookings/types:
get:
tags:
- Bookings
summary: Booking types
operationId: bookings_types_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: FluentBookingController::getTypes (src/Http/Controllers/FluentBookingController.php)
Visibility: dev
Warning: Marked dev-only in docs; do not expose in production.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
types: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/bookings/types/{typeId}:
get:
tags:
- Bookings
summary: Booking type detail
operationId: bookings_types_detail_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: FluentBookingController::getType (src/Http/Controllers/FluentBookingController.php)
Visibility: dev
Warning: Marked dev-only in docs; do not expose in production.'
parameters:
- name: typeId
in: path
required: true
schema:
type: integer
description: Path parameter `typeId`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
type: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/edd/licenses:
get:
tags:
- Edd
summary: (not listed in EndpointDefinitions)
operationId: edd_licenses_list_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: EddLicensesController::listLicenses (src/Http/Controllers/EddLicensesController.php)'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
licenses: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/edd/purchases/{purchaseId}:
get:
tags:
- Edd
summary: (not listed in EndpointDefinitions)
operationId: edd_purchases_detail_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: EddPurchasesController::getPurchase (src/Http/Controllers/EddPurchasesController.php)'
parameters:
- name: purchaseId
in: path
required: true
schema:
type: integer
description: Path parameter `purchaseId`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
purchase: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/edd/purchases:
get:
tags:
- Edd
summary: (not listed in EndpointDefinitions)
operationId: edd_purchases_list_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: EddPurchasesController::listPurchases (src/Http/Controllers/EddPurchasesController.php)'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
purchases: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/forms/fluent/{formId}:
get:
tags:
- Forms
summary: (not listed in EndpointDefinitions)
operationId: forms_fluent_detail_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: FluentFormsController::getForm (src/Http/Controllers/FluentFormsController.php)'
parameters:
- name: formId
in: path
required: true
schema:
type: integer
description: Path parameter `formId`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
form: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/forms/fluentforms/{formId}:
get:
tags:
- Forms
summary: (not listed in EndpointDefinitions)
operationId: forms_fluent_detail_slug_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: FluentFormsController::getForm (src/Http/Controllers/FluentFormsController.php)'
parameters:
- name: formId
in: path
required: true
schema:
type: integer
description: Path parameter `formId`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
form: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/forms/fluent:
get:
tags:
- Forms
summary: (not listed in EndpointDefinitions)
operationId: forms_fluent_list_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: FluentFormsController::listForms (src/Http/Controllers/FluentFormsController.php)'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
forms: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/forms/fluentforms:
get:
tags:
- Forms
summary: (not listed in EndpointDefinitions)
operationId: forms_fluent_list_slug_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: FluentFormsController::listForms (src/Http/Controllers/FluentFormsController.php)'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
forms: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/forms/me/submissions:
get:
tags:
- Forms
summary: (not listed in EndpointDefinitions)
operationId: forms_gravityforms_me_submissions_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: GravityFormsController::listUserSubmissions (src/Http/Controllers/GravityFormsController.php)'
parameters:
- name: formId
in: query
required: false
schema:
type: string
description: Query parameter `formId`.
- name: limit
in: query
required: false
schema:
type: integer
description: Query parameter `limit`.
- name: page
in: query
required: false
schema:
type: integer
description: Query parameter `page`.
- name: since
in: query
required: false
schema:
type: string
description: Query parameter `since`.
- name: until
in: query
required: false
schema:
type: string
description: Query parameter `until`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
submissions: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/forms/submit:
post:
tags:
- Forms
summary: (not listed in EndpointDefinitions)
operationId: forms_gravityforms_submit_post
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: GravityFormsController::submit (src/Http/Controllers/GravityFormsController.php)
Cookie-auth note: If using browser session cookies, mutations typically require X-WP-Nonce (GET /nonce).'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
submission: {}
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/forms/gf/{formId}:
get:
tags:
- Forms
summary: (not listed in EndpointDefinitions)
operationId: forms_gravityforms_detail_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: GravityFormsController::getForm (src/Http/Controllers/GravityFormsController.php)'
parameters:
- name: formId
in: path
required: true
schema:
type: integer
description: Path parameter `formId`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
form: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/forms/gravityforms/{formId}:
get:
tags:
- Forms
summary: (not listed in EndpointDefinitions)
operationId: forms_gravityforms_detail_slug_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: GravityFormsController::getForm (src/Http/Controllers/GravityFormsController.php)'
parameters:
- name: formId
in: path
required: true
schema:
type: integer
description: Path parameter `formId`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
form: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/forms/gf:
get:
tags:
- Forms
summary: (not listed in EndpointDefinitions)
operationId: forms_gravityforms_list_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: GravityFormsController::listForms (src/Http/Controllers/GravityFormsController.php)'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
forms: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/forms/gravityforms:
get:
tags:
- Forms
summary: (not listed in EndpointDefinitions)
operationId: forms_gravityforms_list_slug_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: GravityFormsController::listForms (src/Http/Controllers/GravityFormsController.php)'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
forms: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/give/donations/{donationId}:
get:
tags:
- Give
summary: (not listed in EndpointDefinitions)
operationId: givewp_donations_detail_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: GiveDonationsController::getDonation (src/Http/Controllers/GiveDonationsController.php)'
parameters:
- name: donationId
in: path
required: true
schema:
type: integer
description: Path parameter `donationId`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
donation: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/give/donations:
get:
tags:
- Give
summary: (not listed in EndpointDefinitions)
operationId: givewp_donations_list_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: GiveDonationsController::listDonations (src/Http/Controllers/GiveDonationsController.php)'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
donations: []
pagination:
page: 1
perPage: 10
total: 0
hasMore: false
page: <value>
perPage: <value>
total: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/give/summary:
get:
tags:
- Give
summary: (not listed in EndpointDefinitions)
operationId: givewp_donations_summary_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: GiveDonationsController::getSummary (src/Http/Controllers/GiveDonationsController.php)'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
summary: {}
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/ld/courses/{courseId}:
get:
tags:
- Ld
summary: (not listed in EndpointDefinitions)
operationId: learndash_courses_detail_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: LearnDashCoursesController::getCourse (src/Http/Controllers/LearnDashCoursesController.php)'
parameters:
- name: courseId
in: path
required: true
schema:
type: string
description: Path parameter `courseId`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
course: <value>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/ld/courses:
get:
tags:
- Ld
summary: (not listed in EndpointDefinitions)
operationId: learndash_courses_list_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: LearnDashCoursesController::listCourses (src/Http/Controllers/LearnDashCoursesController.php)'
parameters:
- name: page
in: query
required: false
schema:
type: integer
description: Query parameter `page`.
- name: perPage
in: query
required: false
schema:
type: integer
description: Query parameter `perPage`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
courses: []
pagination:
page: 1
perPage: 10
total: 0
hasMore: false
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/ld/progress:
get:
tags:
- Ld
summary: (not listed in EndpointDefinitions)
operationId: learndash_progress_summary_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: LearnDashProgressController::getProgress (src/Http/Controllers/LearnDashProgressController.php)'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
courses: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/mp/memberships:
get:
tags:
- Mp
summary: (not listed in EndpointDefinitions)
operationId: memberpress_memberships_list_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: MemberPressMembershipsController::listMemberships (src/Http/Controllers/MemberPressMembershipsController.php)'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
memberships: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/mp/rules:
get:
tags:
- Mp
summary: (not listed in EndpointDefinitions)
operationId: memberpress_rules_list_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: MemberPressRulesController::listRules (src/Http/Controllers/MemberPressRulesController.php)'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
rules: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/memberships:
get:
tags:
- Memberships
summary: RCP memberships
operationId: rcp_memberships_list_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: MembershipsController::listUserMemberships (src/Http/Controllers/MembershipsController.php)
Visibility: dev
Warning: Marked dev-only in docs; do not expose in production.'
parameters:
- name: page
in: query
required: false
schema:
type: integer
description: Query parameter `page`.
- name: perPage
in: query
required: false
schema:
type: integer
description: Query parameter `perPage`.
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
memberships: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
/wp-json/headlesswp/v1/store/membership-tiers:
get:
tags:
- Store
summary: RCP membership tiers
operationId: rcp_store_membershipTiers_list_get
description: 'Source: 13_API_REFERENCE_AFFILIATE_RCP_BOOKINGS_FORMS.txt
Handler: MembershipTiersController::listMembershipTiers (src/Http/Controllers/MembershipTiersController.php)
Visibility: dev
Warning: Marked dev-only in docs; do not expose in production.'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/SuccessEnvelope'
example:
data:
tiers: []
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
default:
description: Unexpected error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
example:
error:
code: <ERROR_CODE>
message: <human-readable>
details: {}
httpStatus: <int>
correlationId: <string>
hints:
- <optional>
meta:
correlationId: <string>
correlation_id: <string>
request_id: <string>
timestamp: <ISO-8601 UTC>
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
apiKeyAuth:
type: apiKey
in: header
name: Authorization
description: 'Use `Authorization: HeadlessWPProKey <token>` for service account keys.'
wpNonce:
type: apiKey
in: header
name: X-WP-Nonce
description: Required for cookie-auth mutations; fetch from /nonce.
schemas:
AnyValue:
oneOf:
- type: object
additionalProperties: true
- type: array
items:
$ref: '#/components/schemas/AnyValue'
- type: string
- type: number
- type: boolean
- type: 'null'
Meta:
type: object
properties:
correlationId:
type: string
correlation_id:
type: string
request_id:
type: string
timestamp:
type: string
additionalProperties: true
FieldError:
type: object
properties:
field:
type: string
message:
type: string
code:
type: string
additionalProperties: true
ErrorObject:
type: object
properties:
code:
type: string
message:
type: string
details:
$ref: '#/components/schemas/AnyValue'
httpStatus:
$ref: '#/components/schemas/AnyValue'
correlationId:
type: string
hints:
type: array
items:
type: string
fieldErrors:
type: array
items:
$ref: '#/components/schemas/FieldError'
additionalProperties: true
SuccessEnvelope:
type: object
properties:
data:
$ref: '#/components/schemas/AnyValue'
meta:
$ref: '#/components/schemas/Meta'
required:
- data
- meta
additionalProperties: true
ErrorEnvelope:
type: object
properties:
error:
$ref: '#/components/schemas/ErrorObject'
meta:
$ref: '#/components/schemas/Meta'
required:
- error
- meta
additionalProperties: true