Sign in

v1

latestOpenAPI 3.0.22026-08-045831103.6 KB
Deals

Get deal

Retrieve a single deal by ID

get/v1/deals/{id}

Path parameters

idstring uuid required
Example:8feade82-d77b-4e8b-9d35-fd43e972b5c8

UUID

Headers

api-tokenstring required

API Token

Response

A deal object

statusinteger

Response status

Example response

{
  "data": {
    "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
    "origin_id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
    "user": {
      "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
      "full_name": "User full name"
    },
    "contact": {
      "id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
      "name": "Contact name",
      "email": "contact@email.com",
      "phone": "+5548999999999"
    },
    "created_at": "2020-01-01T14:15:00.000000+00:00",
    "stage_id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
    "updated_stage_at": "2020-01-01T14:15:00.000000+00:00",
    "won_at": "2020-01-01T14:15:00.000000+00:00",
    "won_by": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
    "lost_status_id": "8feade82-d77b-4e8b-9d35-fd43e972b5c8",
    "lost_at": "2020-01-01T14:15:00.000000+00:00",
    "lost_by": "8feade82-d77b-4e8b-9d35-fd43e972b5c8"
  }
}