> 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.md). # API REST - [Introduction](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/introduction.md): Base URLs, the build-sign-submit loop, and the conventions every endpoint follows. - [Single Release Escrow](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy.md): Single-Release Escrow is a type in which all your funds are released only once, either with the resolution of a dispute or by completing all the milestones defined for it. - [Deploy](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/initialize-escrow.md): Deploy the escrow contract and define the escrow properties. - [Fund Escrow](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/fund-escrow.md): Allows users to deposit funds into an existing escrow contract, securing them until the agreed conditions are met. - [Approve Milestones](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/change-milestone-flag.md): Responsible for approving the milestone through the escrow approver. - [Change Milestone Status](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/change-milestone-status.md): Responsible for changing the milestone status of an escrow through the service provider. - [Release Funds](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/release-funds.md): You release the escrow funds to the service provider through the approver. - [Withdraw Remaining Funds](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/withdraw-remaining-funds.md) - [Dispute Escrow](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/change-dispute-flag.md): Responsible for initiating a dispute in an escrow. Change the value of the flag “disputed” from “disputed” to true. - [Resolve Dispute](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/resolving-disputes.md): Resolves escrow disputes by distributing funds to the approver and service provider as determined by the dispute resolver. - [Update Escrow](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/update-escrow-properties.md): This endpoint allows you to change the properties of an escrow as long as a series of requirements are met, which will be mentioned in this section. - [Manage Milestones](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/manage-milestones.md): This endpoint allows the admin to add new milestones to an existing escrow and/or update the description and amount of existing milestones in a single transaction. - [Approve and Release Milestones](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/approve-and-release-milestones.md): Approve milestones and release in a single atomic transaction. - [Extend TTL](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/extend-ttl.md): Extend the escrow contract storage TTL before it expires. - [Get Escrow Balances](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/get-escrow-balances.md): Read token balances of up to 20 escrows directly from the chain. - [Get Escrow](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy/get-escrow.md): Read an escrow state directly from the contract (authoritative). - [Multi Release Escrow](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1.md) - [Deploy](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1/initialize-escrow.md): Deploy the escrow contract and define the escrow properties. - [Fund Escrow](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1/fund-escrow.md): Allows users to deposit funds into an existing escrow contract, securing them until the agreed conditions are met. - [Approve Milestones](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1/change-milestone-flag.md): Responsible for modifying the "flag" property of a specific milestone in the escrow to approve that milestone. - [Change Milestone Status](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1/change-milestone-status.md): Responsible for modifying the "status" property of a specific milestone in the escrow. - [Release Funds](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1/release-funds.md): You release the milestone escrow funds to the service provider through the approver. - [Withdraw Remaining Funds](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1/withdraw-remaining-funds.md) - [Dispute Milestones](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1/change-dispute-flag.md): Responsible for setting the milestone in dispute state. Changes the value of the milestone's "flags.disputed" property to true. - [Resolve Dispute](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1/resolving-disputes.md): Resolves escrow milestone disputes by distributing funds to the approver and service provider as determined by the dispute resolver. - [Update Escrow](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1/update-escrow-properties.md): This endpoint allows you to change the properties of an escrow as long as a series of requirements are met, which will be mentioned in this section. - [Manage Milestones](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1/manage-milestones.md): This endpoint allows the admin to add new milestones to an existing escrow and/or update the description and amount of existing milestones in a single transaction. - [Approve and Release Milestones](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1/approve-and-release-milestones.md): Approve milestones and release in a single atomic transaction. - [Extend TTL](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1/extend-ttl.md): Extend the escrow contract storage TTL before it expires. - [Get Escrow Balances](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1/get-escrow-balances.md): Read token balances of up to 20 escrows directly from the chain. - [Get Escrow](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/deploy-1/get-escrow.md): Read an escrow state directly from the contract (authoritative). - [Stellar](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/stellar.md): These endpoints provide a way to receive tokens through Trustline and send any transactions to the Stellar Blockchain. - [Send Transaction](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/stellar/send-transaction.md): Most Trustless Work endpoints return an unsigned transaction in XDR format. This endpoint is used to sign such unsigned transactions and send them to the Stellar network. - [Escrows](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/escrows.md): The read endpoints: list, detail, events, milestones, financial and GraphQL. - [List Escrows](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/escrows/list-escrows.md): List escrows with filters and keyset pagination via GET /escrows. - [Get Escrow](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/escrows/get-escrow.md): Read one escrow in full: state, participants, timeline and deposits. - [Get Escrow Events](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/escrows/get-escrow-events.md): Page an escrow event timeline. - [Get Escrow Milestones](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/escrows/get-escrow-milestones.md): Read the milestones of one escrow or a batch. - [Get Escrows Financial](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/escrows/get-multiple-escrow-balance.md): Balances, deposits, releases and fees for up to 50 escrows via GET /escrows/financial. - [Get Escrows Details](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/escrows/get-escrow-by-contract-ids.md): Batch-read the full state of up to 50 escrows via GET /escrows/details. - [Get Escrows By Signer](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/escrows/get-escrow-by-contract-id.md): List every escrow a wallet participates in via GET /escrows?participant=. - [Get Escrows By Role](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/escrows/get-escrow-by-contract-id-1.md): Filter escrows by the role a wallet holds. - [Update From Tx Hash](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/escrows/update-escrow-properties.md): This endpoint was removed. The Indexer now projects on-chain state automatically. - [GraphQL](https://docs.trustlesswork.com/trustless-work/v2-en/api-rest/escrows/graphql.md): Read the same escrow data with field selection over a single POST endpoint. --- # 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 dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.trustlesswork.com/trustless-work/v2-en/api-rest.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. 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.