BeagelEnterprise API docs
\nLicense & Usage Notice
\nLicense
The Beagel Enterprise Restricted License governs use of this API and its documentation. By testing or using these endpoints (e.g., https://sandbox.beagel.io), you agree to the full terms at github.com/healyhynes/beagel-enterprise/LICENSE.txt, including restrictions on modifying, redistributing, or creating competing offerings.
Definitions
\n\"Licensed Work\": All code, documentation, specifications, schemas, examples, tests, and API definitions (e.g., OpenAPI/Swagger) in this repository or documentation.
\n\"Competing Product\": Any service or software replicating Beagel’s backend functionality for real estate offer creation, bid management, or transaction workflows.
\n\"Transaction Data\": Data generated via API testing or use (e.g., offers, bids, status histories, audit logs), excluding user-entered data from external sources (e.g., third-party databases).
\nPermitted Uses
\nTest the API in Postman or similar tools to build front-end applications or services (e.g., UI, dashboards, client logic) that do not include a Competing Product.
\nInspect the Licensed Work to understand API design and integration.
\nProhibited Actions
\nModifying, forking, copying, or creating derivative works from the Licensed Work, including via Postman forking.
\nDistributing, rehosting, or sublicensing the Licensed Work.
\nDeveloping or marketing a Competing Product using the API or Licensed Work.
\nUsing Beagel’s name, logos, or branding without written permission.
\nTransaction Data Rights
\nGoValGo Ltd. retains exclusive ownership of all Transaction Data generated during testing or use.
\nYou are granted a non-exclusive, revocable license to access Transaction Data within your applications for non-resale, non-third-party purposes.
\nGoValGo Ltd. may analyze or monetize anonymized/aggregated Transaction Data, per our Privacy Policy (beagel.io/privacy), compliant with GDPR.
\nYou may not export or share Transaction Data without GoValGo Ltd.’s written consent.
\nSandbox Enforcement
\nSandbox environments (e.g., clienta.beagel.io) are for development/testing only, must display a “sandbox/testing” watermark, and cannot be used for production or revenue-generating operations.
\nGoValGo Ltd. may revoke sandbox access at its discretion.
\nTermination & Liability
\nViolation of these terms terminates your access. You must cease use, delete all copies of the Licensed Work, and stop API access.
\nThe API, Licensed Work, and Transaction Data are provided “as is” without warranty. GoValGo Ltd. disclaims all liability, including for direct, indirect, or consequential damages.
\nJurisdiction
\nThis license is governed by Irish law. Disputes shall be resolved via binding arbitration in Dublin, Ireland, or in Dublin courts if arbitration is not feasible.
\nSee our Privacy Policy at beagel.io/privacy for data protection details.
\nThis License is permanent and does not change.
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"33299872","collectionId":"028556f6-a91a-4641-94c8-468b7e00a302","publishedId":"2sB3QMKUGN","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-10-12T16:21:52.000Z"},"item":[{"name":"api","item":[{"name":"Account","item":[{"name":"GetBranchUser","item":[{"name":"Gets the branch user by User id (Roles: GroupUser, AgencyUser, BranchUser, Admin, SuperAdmin)","id":"3bb07ad9-c172-4410-9f00-d9c29d8d514b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"//api/Account/GetBranchUser?UserId=string","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"028556f6-a91a-4641-94c8-468b7e00a302","id":"028556f6-a91a-4641-94c8-468b7e00a302","name":"BeagelEnterprise","type":"collection"}},"urlObject":{"path":["api","Account","GetBranchUser"],"host":["/"],"query":[{"key":"UserId","value":"string"}],"variable":[]}},"response":[{"id":"1b1b1325-2780-4cf9-a92f-404ca6285c1b","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThe authorization code.
\n","type":"text/plain"},"key":"code","value":"string"},{"key":"state","value":"string"}],"variable":[]}},"response":[{"id":"41882225-bd4c-4db5-8a98-7fc12eab0645","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"BearerThis method will be deprecated after 2026-06-30. Please use /api/Sale/GetSalesByAgencyRefGroupId instead
\n","auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{bearerToken}}"}]},"isInherited":true,"source":{"_postman_id":"028556f6-a91a-4641-94c8-468b7e00a302","id":"028556f6-a91a-4641-94c8-468b7e00a302","name":"BeagelEnterprise","type":"collection"}},"urlObject":{"path":["api","Sale","GetSalesWithAgencyRefId"],"host":["/"],"query":[{"key":"agencyRefId","value":"string"},{"key":"groupId","value":"string"}],"variable":[]}},"response":[{"id":"1a4debb2-1c9c-4135-860c-e40a7a178adc","name":"OK","originalRequest":{"method":"GET","header":[{"description":"Added as a part of security scheme: bearer","key":"Authorization","value":"Bearer