Retrieve a specific deal

GET

https://sandbox.useme.com/api/1.0/deal/{deal_pk}/

Deals

Fetches details of a specific deal using its ID. Only the employer associated with the user can access this information.

Request

Path Params

deal_pk

integer

required

Deal ID

Header Params

Authorization

string

required

Authorization token for the sandbox environment.

Default:

Token <here-paste-your-token>

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200Returns the details of the specified deal.

application/json

Body

success

boolean

optional

Default:

true

data

object (GetDealStageData)

required

integer

required

The unique identifier of the deal.

contractor_email

string <email>

required

Email address of the contractor associated with the deal.

partner_id

integer

required

The unique identifier of the deal in the partner's system.

Example

{
  "success": true,
  "data": {
    "id": 1001,
    "contractor_email": "contractor@email.com",
    "partner_id": 2001
  }
}

🟠404Deal not found or the user does not have permission to view it.

Modified at 2024-05-07 08:34:28

Create a new deal

Upload a file for a deal