Objects

Get a deal

Retrieve a single deal by deal ID.

Overview

Use this endpoint to read one deal record. It requires public api oauth access token authentication and the crm.deals.read scope.

GET/api/crm/objects/deals/{dealId}

cURL

GET

bash

curl --request GET \  --url 'https://crm.notifyy.io/api/crm/objects/deals/55?properties=name%2Camount%2Ccurrency%2Cpipeline%2Cstage&associations=company%2Ccontact' \  --header 'Authorization: Bearer nfy_public_api_access_token'

Authorization

Public API OAuth access token

crm.deals.read

Sample Request Body

This endpoint does not require a request body.

Sample Response

json

{  "success": true,  "message": "Deal retrieved successfully",  "data": {    "id": 55,    "properties": {      "name": "Enterprise Renewal",      "amount": "12000",      "currency": "USD",      "pipeline": "sales_pipeline",      "stage": "proposal_sent"    },    "associations": {      "company": [        {          "id": "456",          "type": "deal_to_company"        }      ],      "contact": [        {          "id": "789",          "type": "deal_to_contact"        }      ]    }  }}

Status Codes

Code	Description
200	Deal was returned.

Headers

AuthorizationstringRequired

Public API OAuth bearer token.

Example: Bearer nfy_public_api_access_token

Object	Description
Authorization string	RequiredPublic API OAuth bearer token. Example: Bearer nfy_public_api_access_token

Path parameters

dealIdintegerRequired

Deal ID.

Example: 55

Object	Description
dealId integer	RequiredDeal ID. Example: 55

Query parameters

propertiesstringOptional

Comma-separated property internal names to return.

Example: name,amount,currency,pipeline,stage

associationsstringOptional

Comma-separated associated object types to include.

Example: company,contact

Object	Description
properties string	OptionalComma-separated property internal names to return. Example: name,amount,currency,pipeline,stage
associations string	OptionalComma-separated associated object types to include. Example: company,contact

Response fields

data.idinteger

Deal record ID.

data.propertiesobject

Requested deal properties keyed by internal name.

Object	Description
data.id integer	Deal record ID.
data.properties object	Requested deal properties keyed by internal name.