1. Deals
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
        POST
      • Retrieve deal details
        GET
      • Upload a file for a deal
        POST
  • 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. Deals

Retrieve deal details

GET
https://sandbox.useme.com/api/1.0/deal/{deal_pk}/
Returns full details of a single deal owned by the authenticated employer, including stage identifier, payment token, current status, currency, and billing breakdown for both sides.

Request

Path Params

Header Params

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://sandbox.useme.com/api/1.0/deal//' \
--header 'Authorization: Token <here-paste-your-token>'

Responses

🟢200
application/json
The deal details were successfully retrieved.
Body

Example
{
    "success": true,
    "data": {
        "id": 1001,
        "stage_id": 5001,
        "contractor_email": "contractor@email.com",
        "partner_id": "partner-deal-2001",
        "status": "created",
        "payment_token": "UMCSDVCX",
        "currency": "EUR",
        "billing": {
            "commission": "120.00",
            "employer": {
                "net_amount": "1000.00",
                "vat_amount": "230.00",
                "gross_amount": "1230.00"
            },
            "freelancer": {
                "net_amount": "850.00",
                "vat_amount": "0.00",
                "pit_advance": "0.00",
                "gross_amount": "850.00"
            }
        }
    }
}
🟠404
🔴500
Modified at 2026-05-05 07:55:37
Previous
Create a new deal
Next
Upload a file for a deal
Built with