Get Deal

GET

GET

https://api.atzcrm.com/v1/deal/:slug

Retrieve the details of a specific deal by their unique slug.

Request

GET

GET /v1/deal/:slug

Path Parameter

• slugstring

  Replace :slug with the deal's unique slug in the request URL.

Query Parameter

• Maximizestring

  The maximize parameter allows you to specify which items to maximize in your API response.It is comma separated string values. The following values are allowed:

  • owner
  • created_by
  • updated_by
  • organization
  • job
  • candidate
  • stage
  • contact

  Note: To maximize all the items in the response, you can pass 'all' as the value for the maximize query parameter.

  Example usage:

  GET /v1/deal/:slug?maximize=owner,stage,organization

Response

200

Body

• idnumber

  Example: 28

• slugstring

  Example: contact_68ba678fcd2a83f4640c

• namestring

  Example: Anjali kotwani

• stageobject

  Example:
  "id": 1,
  "label": "win",
  "percentage": "100"

• deal_amountnumber

  Example: 22

• amount_by_stagenumber

  Example: 2.2

• close_datestring

  Example: 1990-02-02

• deal_typestring

  Example: "1"

• organizationobject

  Example:
  "id": 1

• jobsobject

  Example:
  "id": 1

• candidatesobject

  Example:
  "id": 1

• contactsobject

  Example:
  "id": 1

• tagsstring

  Example: [leader,java]

• created_atstring (ISO 8601 date)

  Example: 2015-05-15T00:00:00Z

• updated_atstring (ISO 8601 date)

  Example: 2015-05-15T00:00:00Z

• created_byobject

  Example:
  "id": 1,
  "email": "Rohan@abc.com",
  "first_name": "Rohan",
  "last_name": "Sharma",
  "full_name": "Rohan Sharma",
  "role": "Admin",
  "phone": null

• updated_byobject

  Example:
  "id": 1,
  "email": "Rohan@abc.com",
  "first_name": "Rohan",
  "last_name": "Sharma",
  "full_name": "Rohan Sharma",
  "role": "Admin",
  "phone": null

• ownerobject

  Example:
  "id": 1,
  "email": "Rohan@abc.com",
  "first_name": "Rohan",
  "last_name": "Sharma",
  "full_name": "Rohan Sharma",
  "role": "Admin",
  "phone": null

• custom fields:object

  Example:
  "id": 1,
  "field_name": "textfeild",
  "field_type": "string",
  "value": "anjali"

404

Error

• Deal does not found

Response Example

{
    "id": 11,
    "slug": "deal_b93fc43d76fff40d6647",
    "name": "software engineer",
    "stage": {
        "id": 4
    },
    "deal_amount": 11,
    "amount_by_stage": 2.2,
    "close_date": "2024-08-07",
    "deal_type": 1,
    "organization": {
        "id": 8
    },
    "jobs": [],
    "candidates": [],
    "contacts": [],
    "tags": null,
    "created_at": "2024-08-06T13:33:00.000Z",
    "updated_at": "2024-08-06T13:33:33.000Z",
    "created_by": {
        "id": 1,
        "email": "Rohan@abc.com",
        "first_name": "Rohan",
        "last_name": "Sharma",
        "full_name": "Rohan Sharma",
        "role": "Admin",
        "phone": null
    },
    "updated_by": {
        "id": 1,
        "email": "Rohan@abc.com",
        "first_name": "Rohan",
        "last_name": "Sharma",
        "full_name": "Rohan Sharma",
        "role": "Admin",
        "phone": null
    },
    "owner": {
         "id": 1,
        "email": "Rohan@abc.com",
        "first_name": "Rohan",
        "last_name": "Sharma",
        "full_name": "Rohan Sharma",
        "role": "Admin",
        "phone": null
    },
    "custom_fields": [
        {
            "id": 2,
            "field_name": "test deal",
            "field_type": "phone",
            "value": ""
        },
        {
            "id": 3,
            "field_name": "File",
            "field_type": "file",
            "value": ""
        },
        {
            "id": 1,
            "field_name": "TEst after delete",
            "field_type": "text",
            "value": ""
        }
    ]
}