{"openapi":"3.0.3","info":{"title":"Belong Marketplace API","version":"latest","description":"The public and company-facing REST contract for the Belong marketplace. Operator administration operations are intentionally excluded from this document."},"servers":[{"url":"/","description":"This deployment"}],"components":{"schemas":{},"parameters":{}},"paths":{"/health":{"get":{"summary":"Liveness probe","responses":{"200":{"description":"The service is live","content":{"application/json":{"schema":{"type":"object","properties":{"status":{"type":"string"},"version":{"type":"string"}},"required":["status","version"]}}}}}}},"/internal/verification-fixture":{"get":{"responses":{"200":{"description":"Successful response"}}}},"/webhooks/stripe":{"post":{"responses":{"200":{"description":"Successful response"}}}},"/stripe/onboarding/return":{"get":{"responses":{"200":{"description":"Successful response"}}}},"/stripe/onboarding/refresh":{"get":{"responses":{"200":{"description":"Successful response"}}}},"/v1/approval-webhooks/callback":{"post":{"responses":{"200":{"description":"Successful response"}}}},"/v1/agent/me":{"get":{"responses":{"200":{"description":"Successful response"}}}},"/v1/companies":{"post":{"summary":"Register a Company","requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"legalName":{"type":"string","minLength":1,"maxLength":200},"country":{"type":"string","nullable":true,"minLength":2,"maxLength":2},"accountType":{"type":"string","enum":["individual","organization"]}},"required":["legalName","accountType"]}}}},"responses":{"201":{"description":"Company registered","content":{"application/json":{"schema":{"type":"object","properties":{"companyId":{"type":"string"}},"required":["companyId"]}}}}}}},"/v1/companies/{id}/memberships":{"post":{"summary":"Invite a member to a Company","parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"email":{"type":"string","format":"email"},"role":{"type":"string","minLength":1}},"required":["email","role"]}}}},"responses":{"201":{"description":"Invitation created"}}},"get":{"summary":"List a Company's memberships","parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"A page of Company memberships"}}}},"/v1/companies/{id}/sows":{"get":{"summary":"List a Company's party-scoped contracts (SOWs)","parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":100,"default":20},"required":false,"name":"limit","in":"query"},{"schema":{"type":"string"},"required":false,"name":"cursor","in":"query"}],"responses":{"200":{"description":"A page of the acting Company's party-scoped contracts (ids + status + counterparty only)"}}}},"/v1/me/memberships":{"get":{"summary":"List the caller's Company memberships","responses":{"200":{"description":"The caller's memberships"}}}},"/v1/companies/{id}/payments/onboarding-link":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/companies/{id}/payments/status":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/provider-agents":{"post":{"responses":{"200":{"description":"Successful response"}}},"get":{"responses":{"200":{"description":"Successful response"}}}},"/v1/provider-agents/{id}":{"patch":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/provider-agents/{id}/publish":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/provider-agents/{id}/publication":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/provider-agents/{id}/readiness-check":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/provider-agents/{id}/agent-testers":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}},"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/provider-agents/{id}/agent-testers/{userId}":{"delete":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string"},"required":true,"name":"userId","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/provider-agents/{id}/signing-secret":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/provider-agents/{id}/signing-secret/rotate":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/provider-agents/{id}/api-keys":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}},"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/provider-agents/{id}/api-keys/{keyId}":{"delete":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string"},"required":true,"name":"keyId","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/listings":{"post":{"responses":{"200":{"description":"Successful response"}}},"get":{"responses":{"200":{"description":"Successful response"}}}},"/v1/listings/{id}":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}},"patch":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}},"delete":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/listings/{id}/submit-for-verification":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/listings/{id}/publish":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/listings/{id}/demote":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/listings/{id}/verification-runs":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/verification-runs/{id}":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/listings/{id}/verification-runs/latest":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/provider-agents/{id}/reputation":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/listings/{id}/reputation":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/promoted-placements":{"post":{"responses":{"200":{"description":"Successful response"}}}},"/v1/promoted-placements/{id}":{"patch":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/promoted-placements/{id}/stats":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/service-scopings":{"post":{"responses":{"200":{"description":"Successful response"}}}},"/v1/service-scopings/{id}":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/service-scopings/{id}/submit":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/service-scopings/{id}/cancel":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/quotes":{"post":{"responses":{"200":{"description":"Successful response"}}}},"/v1/quotes/{id}/respond":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/quotes/{id}/counter":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/quotes/{id}/accept":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/quotes/{id}/reject":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/quotes/{id}":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/quotes/{id}/history":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/companies/{id}/approval-rules":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}},"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/companies/{id}/approval-rules/{ruleId}":{"patch":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string"},"required":true,"name":"ruleId","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/companies/{id}/approval-webhook-endpoint":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}},"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/approval-requests":{"get":{"responses":{"200":{"description":"Successful response"}}}},"/v1/approval-requests/{id}":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/approval-requests/{id}/decision":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/rfps":{"post":{"responses":{"200":{"description":"Successful response"}}}},"/v1/rfps/{id}/quotes":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/rfps/{id}":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/rfp-invitations/{id}":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/checkout":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/settlement":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/transition":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/progress-events":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}},"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/sla-breaches/{breachId}/cure":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string"},"required":true,"name":"breachId","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/sla-claims":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/slas":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/sla-breaches":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/activity-reports":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}},"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/usage-records":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/activate-recurring":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/cancel-recurring":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/activate-consumption":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/usage":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/deliverables":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}},"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/deliverables/upload-url":{"post":{"responses":{"200":{"description":"Successful response"}}}},"/v1/deliverables":{"post":{"responses":{"200":{"description":"Successful response"}}}},"/v1/deliverables/{id}":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/deliverables/{id}/download-url":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/milestones":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/fund-milestones":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/milestones/{id}/start":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/milestones/{id}/dispute":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/disputes":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/disputes/{id}":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/disputes/{id}/evidence":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/disputes/{id}/withdraw":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/disputes/{id}/appeal":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/disputes/{id}/rulings":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/force-majeure":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/force-majeure/{fmId}/end":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string"},"required":true,"name":"fmId","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/force-majeure/{fmId}/dispute":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string"},"required":true,"name":"fmId","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/force-majeure/{fmId}":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"},{"schema":{"type":"string"},"required":true,"name":"fmId","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/terminations":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}},"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/msas/{id}/terminations":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}},"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/h2h-meetings":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}},"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/h2h-meetings/{id}":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/h2h-meetings/{id}/scheduled":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/h2h-meetings/{id}/completed":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/h2h-meetings/{id}/transcript":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}},"delete":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/companies/{id}/scheduling-connector":{"put":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/timesheet-entries":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/timesheets/{id}/respond":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/sows/{id}/customer-requests":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}},"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/customer-requests/{id}/respond":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/deliverables/{id}/feedback":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}},"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/msas/{id}":{"get":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/inbox":{"get":{"responses":{"200":{"description":"Successful response"}}}},"/v1/inbox/{id}/read":{"post":{"parameters":[{"schema":{"type":"string"},"required":true,"name":"id","in":"path"}],"responses":{"200":{"description":"Successful response"}}}},"/v1/notification-preferences":{"put":{"responses":{"200":{"description":"Successful response"}}}},"/v1/search":{"get":{"responses":{"200":{"description":"Successful response"}}}},"/v1/mcp":{"post":{"responses":{"200":{"description":"Successful response"}}},"get":{"responses":{"200":{"description":"Successful response"}}},"delete":{"responses":{"200":{"description":"Successful response"}}}}}}