1. Guides
Useme API docs
  • Guides
    • Introduction
    • Getting Started
    • Creating Contractors
    • Creating Deals
    • Retrieving Deal Details
  • Reference
    • Categories
      • List categories
    • Contractors
      • Create a new contractor
    • Deals
      • Create a new deal
      • Retrieve deal details
      • Upload a file for a deal
  • Schemas
    • Schemas
      • ContractorRequest
      • DealDetailsResponse
      • DealRequest
      • GetDealStageData
      • MainCategory
      • WorkFileRequest
    • APIDealBilling
    • BadRequestResponse
    • ConflictResponse
    • APIDealContractorPayment
    • Contractor
    • APIDealEmployerPayment
    • ContractorData
    • APIRetrieveDealResponse
    • CountryCodeEnum
    • DealCreateSuccessResponse
    • Deal
    • DealStageData
    • ErrorResponse
    • FileUploadData
    • FileUploadResponse
    • SubCategory
    • SuccessResponse
    • ValidationErrorResponse
    • RetrieveDealNotFoundResponse
    • RetrieveDealServerErrorResponse
    • RetrieveDealSuccessResponse
    • StatusEnum
    • WorkFile
  1. Guides

Retrieving Deal Details

After creating a deal, your integration can retrieve its current state from Useme.
This is useful when you want to synchronize your system with Useme, show the user the latest deal progress, or continue the flow after the deal has been created. The retrieved data includes the current public deal status, payment token, contractor assignment, stage identifier, currency, and billing summary.
A common flow looks like this:
1.
Create a contractor.
2.
Create a deal using your own partner_id.
3.
Store the returned Useme deal id.
4.
Retrieve the deal when you need the latest status or payment information.
5.
Use the returned stage_id when uploading work files.
The retrieve endpoint only returns deals owned by the authenticated employer account. If a deal belongs to another account or does not exist, it is treated as not found.
For the full request and response schema, see the Retrieve deal details endpoint reference.
Modified at 2026-05-05 08:08:21
Previous
Creating Deals
Next
List categories
Built with