> For the complete documentation index, see [llms.txt](https://docs.trustlesswork.com/trustless-work/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/escrow-information/get-escrow.md). # Get Escrow Read an escrow state directly from the contract (authoritative). Reads the escrow's state **directly from the contract** by invoking `get_escrow` on-chain β€” including milestone approvals, dispute and released flags. This is the authoritative read β€” use it for settlement-grade checks. For lists, dashboards and history, the [read-model endpoints](/trustless-work/v2-en/api-rest/escrow-information/list-escrows.md) are faster and richer. Use the endpoint that matches your escrow's contract flavor β€” the two are not interchangeable. ## Single Release (v2) ## Read the on-chain state of a deployed escrow > Invokes \`get\_escrow\` directly on the child contract. ```json {"openapi":"3.0.0","info":{"title":"πŸ‘‹πŸΌ Trustless Work Core API β€” All Endpoints (Unified)","version":"1.0"},"servers":[{"url":"https://beta.api.trustlesswork.com"}],"security":[{}],"paths":{"/escrow/single-release/v2/{contractId}":{"get":{"description":"Invokes `get_escrow` directly on the child contract.","operationId":"GetSingleReleaseV2EscrowController_get","parameters":[{"name":"contractId","required":true,"in":"path","description":"Deployed single-release-v2 escrow contract (C...).","schema":{"type":"string"}}],"responses":{"200":{"description":"Escrow state read successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SingleReleaseV2EscrowResponse"}}}},"400":{"description":"Request body or query params fail schema validation (wrong type, missing required field, unknown property).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsResponseDto"}}}},"401":{"description":"Missing, malformed, expired, revoked or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsResponseDto"}}}},"403":{"description":"API key is valid but does not have the role required for this operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsResponseDto"}}}},"422":{"description":"Payload is well-formed but a business rule rejects it (e.g. amount out of range, role not allowed for this user).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsResponseDto"}}}},"500":{"description":"Unexpected server-side failure. Use the `traceId` to look up the incident in server logs or contact support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsResponseDto"}}}}},"summary":"Read the on-chain state of a deployed escrow","tags":["Single Release Escrow V2"]}}},"components":{"schemas":{"SingleReleaseV2EscrowResponse":{"type":"object","properties":{"type":{"type":"string"},"contractId":{"type":"string"},"contractBaseId":{"type":"string"},"engagementId":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"amount":{"type":"number","description":"Total escrow amount in decimals."},"balance":{"type":"number","description":"Funded balance, `0` until first fund."},"platformFee":{"type":"number","description":"Platform fee as percent (e.g. 5 = 5%)."},"receiverMemo":{"type":"number"},"trustline":{"$ref":"#/components/schemas/SingleReleaseV2TrustlineResponse"},"roles":{"$ref":"#/components/schemas/SingleReleaseV2RolesResponse"},"milestones":{"type":"array","items":{"$ref":"#/components/schemas/SingleReleaseV2MilestoneResponse"}},"dispute":{"$ref":"#/components/schemas/SingleReleaseV2DisputeResponse"},"released":{"type":"boolean","description":"True after `release_funds` succeeds."}},"required":["type","contractId","contractBaseId","engagementId","title","description","amount","balance","platformFee","receiverMemo","trustline","roles","milestones","dispute","released"]},"SingleReleaseV2TrustlineResponse":{"type":"object","properties":{"address":{"type":"string"},"contractId":{"type":"string"},"symbol":{"type":"string"}},"required":["address","contractId","symbol"]},"SingleReleaseV2RolesResponse":{"type":"object","properties":{"approvers":{"type":"array","items":{"type":"string"}},"serviceProviders":{"type":"array","items":{"type":"string"}},"platform":{"type":"string"},"releaseSigners":{"type":"array","items":{"type":"string"}},"disputeResolvers":{"type":"array","items":{"type":"string"}},"receiver":{"type":"string"},"admin":{"type":"string"},"observers":{"type":"array","items":{"type":"string"}}},"required":["approvers","serviceProviders","platform","releaseSigners","disputeResolvers","receiver","admin","observers"]},"SingleReleaseV2MilestoneResponse":{"type":"object","properties":{"description":{"type":"string"},"status":{"type":"string"},"evidence":{"type":"string"},"approvals":{"$ref":"#/components/schemas/SingleReleaseV2MilestoneApprovalsResponse"}},"required":["description","status","evidence","approvals"]},"SingleReleaseV2MilestoneApprovalsResponse":{"type":"object","properties":{"target":{"type":"number","description":"Distinct approvals required."},"approvalCount":{"type":"number","description":"Approvals received so far."},"approvedBy":{"type":"array","items":{"type":"string"}}},"required":["target","approvalCount","approvedBy"]},"SingleReleaseV2DisputeResponse":{"type":"object","properties":{"isDisputed":{"type":"boolean"},"reason":{"type":"string"},"resolved":{"type":"boolean"}},"required":["isDisputed","reason","resolved"]},"ProblemDetailsResponseDto":{"type":"object","properties":{"type":{"type":"string","description":"Stable URI identifying the error type. Hash-link points to the docs."},"title":{"type":"string","description":"Short human-readable summary of the problem."},"status":{"type":"number","description":"HTTP status code, repeated here for typed clients."},"code":{"type":"string","description":"Machine-readable error code. Stable across versions; safe to switch on."},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence."},"instance":{"type":"string","description":"URI of the request that triggered the error."},"traceId":{"type":"string","description":"Correlation id propagated from the `X-Trace-Id` header (or generated). Use it when contacting support to reference a specific request."},"extensions":{"type":"object","description":"Optional structured context. Shape depends on the error code; documented per-endpoint when relevant.","additionalProperties":true}},"required":["type","title","status","code","detail"]}}}} ``` ## Multi Release (v2) ## Read the on-chain state of a deployed escrow > Invokes \`get\_escrow\` directly on the child contract. ```json {"openapi":"3.0.0","info":{"title":"πŸ‘‹πŸΌ Trustless Work Core API β€” All Endpoints (Unified)","version":"1.0"},"servers":[{"url":"https://beta.api.trustlesswork.com"}],"security":[{}],"paths":{"/escrow/multi-release/v2/{contractId}":{"get":{"description":"Invokes `get_escrow` directly on the child contract.","operationId":"GetMultiReleaseV2EscrowController_get","parameters":[{"name":"contractId","required":true,"in":"path","description":"Deployed multi-release-v2 escrow contract (C...).","schema":{"type":"string"}}],"responses":{"200":{"description":"Escrow state read successfully.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiReleaseV2EscrowResponse"}}}},"400":{"description":"Request body or query params fail schema validation (wrong type, missing required field, unknown property).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsResponseDto"}}}},"401":{"description":"Missing, malformed, expired, revoked or invalid API key.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsResponseDto"}}}},"403":{"description":"API key is valid but does not have the role required for this operation.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsResponseDto"}}}},"422":{"description":"Payload is well-formed but a business rule rejects it (e.g. amount out of range, role not allowed for this user).","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsResponseDto"}}}},"500":{"description":"Unexpected server-side failure. Use the `traceId` to look up the incident in server logs or contact support.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProblemDetailsResponseDto"}}}}},"summary":"Read the on-chain state of a deployed escrow","tags":["Multi Release Escrow V2"]}}},"components":{"schemas":{"MultiReleaseV2EscrowResponse":{"type":"object","properties":{"type":{"type":"string"},"contractId":{"type":"string"},"contractBaseId":{"type":"string"},"engagementId":{"type":"string"},"title":{"type":"string"},"description":{"type":"string"},"balance":{"type":"number","description":"Funded balance, `0` until first fund."},"platformFee":{"type":"number","description":"Platform fee as percent."},"receiverMemo":{"type":"number"},"trustline":{"$ref":"#/components/schemas/MultiReleaseV2TrustlineResponse"},"roles":{"$ref":"#/components/schemas/MultiReleaseV2RolesResponse"},"milestones":{"type":"array","items":{"$ref":"#/components/schemas/MultiReleaseV2MilestoneResponse"}}},"required":["type","contractId","contractBaseId","engagementId","title","description","balance","platformFee","receiverMemo","trustline","roles","milestones"]},"MultiReleaseV2TrustlineResponse":{"type":"object","properties":{"address":{"type":"string"},"contractId":{"type":"string"},"symbol":{"type":"string"}},"required":["address","contractId","symbol"]},"MultiReleaseV2RolesResponse":{"type":"object","properties":{"approvers":{"type":"array","items":{"type":"string"}},"serviceProviders":{"type":"array","items":{"type":"string"}},"platform":{"type":"string"},"releaseSigners":{"type":"array","items":{"type":"string"}},"disputeResolvers":{"type":"array","items":{"type":"string"}},"admin":{"type":"string"},"observers":{"type":"array","items":{"type":"string"}}},"required":["approvers","serviceProviders","platform","releaseSigners","disputeResolvers","admin","observers"]},"MultiReleaseV2MilestoneResponse":{"type":"object","properties":{"description":{"type":"string"},"status":{"type":"string"},"evidence":{"type":"string"},"approvals":{"$ref":"#/components/schemas/MultiReleaseV2MilestoneApprovalsResponse"},"amount":{"type":"number","description":"Milestone amount in human-readable decimals."},"dispute":{"$ref":"#/components/schemas/MultiReleaseV2DisputeResponse"},"released":{"type":"boolean","description":"True after this milestone has been released."},"receiver":{"type":"string","description":"Final beneficiary of this milestone’s payout."}},"required":["description","status","evidence","approvals","amount","dispute","released","receiver"]},"MultiReleaseV2MilestoneApprovalsResponse":{"type":"object","properties":{"target":{"type":"number"},"approvalCount":{"type":"number"},"approvedBy":{"type":"array","items":{"type":"string"}}},"required":["target","approvalCount","approvedBy"]},"MultiReleaseV2DisputeResponse":{"type":"object","properties":{"isDisputed":{"type":"boolean"},"reason":{"type":"string"},"resolved":{"type":"boolean"}},"required":["isDisputed","reason","resolved"]},"ProblemDetailsResponseDto":{"type":"object","properties":{"type":{"type":"string","description":"Stable URI identifying the error type. Hash-link points to the docs."},"title":{"type":"string","description":"Short human-readable summary of the problem."},"status":{"type":"number","description":"HTTP status code, repeated here for typed clients."},"code":{"type":"string","description":"Machine-readable error code. Stable across versions; safe to switch on."},"detail":{"type":"string","description":"Human-readable explanation specific to this occurrence."},"instance":{"type":"string","description":"URI of the request that triggered the error."},"traceId":{"type":"string","description":"Correlation id propagated from the `X-Trace-Id` header (or generated). Use it when contacting support to reference a specific request."},"extensions":{"type":"object","description":"Optional structured context. Shape depends on the error code; documented per-endpoint when relevant.","additionalProperties":true}},"required":["type","title","status","code","detail"]}}}} ``` ## Field notes * Read-only: nothing to sign, nothing to submit. * Calling the endpoint of the wrong flavor for a contract fails β€” check the escrow's `type` in the read-model if you are unsure. * If the contract's storage has expired, the read fails with `STELLAR_STATE_ARCHIVED` β€” see Extend TTL ([single-release](/trustless-work/v2-en/api-rest/deploy/extend-ttl.md) / [multi-release](/trustless-work/v2-en/api-rest/deploy-1/extend-ttl.md)) for the restore flow. --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/escrow-information/get-escrow.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.