Skip to main content
GET
/
api
/
deals
/
{id}
Get Deal by ID
curl --request GET \
  --url https://api.mayerex.com/api/deals/{id} \
  --header 'Authorization: Bearer <token>'
{
  "id": 123,
  "owner": {
    "id": 123,
    "userId": 123,
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "teams": "<string>",
    "hubspotTeamId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "projectManager": {
    "id": 123,
    "userId": 123,
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "teams": "<string>",
    "hubspotTeamId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "postInstallEngineer": {
    "id": 123,
    "userId": 123,
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "teams": "<string>",
    "hubspotTeamId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "postInstallProjectManager": {
    "id": 123,
    "userId": 123,
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "teams": "<string>",
    "hubspotTeamId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "ixCoordinator": {
    "id": 123,
    "userId": 123,
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "teams": "<string>",
    "hubspotTeamId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "permitCoordinator": {
    "id": 123,
    "userId": 123,
    "email": "<string>",
    "firstName": "<string>",
    "lastName": "<string>",
    "teams": "<string>",
    "hubspotTeamId": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z"
  },
  "dealname": "<string>",
  "firstName": "<string>",
  "lastName": "<string>",
  "coordinates": "<string>",
  "state": "<string>",
  "streetAddress": "<string>",
  "city": "<string>",
  "zipCode": "<string>",
  "primaryPhone": "<string>",
  "nameOnUb": "<string>",
  "utilityName": "<string>",
  "stage": "<string>",
  "stageId": "<string>",
  "pipelineId": "<string>",
  "pipeline": "<string>",
  "amount": 123,
  "totalPpw": 123,
  "basePpw": 123,
  "adderPpw": "<string>",
  "adderCost": 123,
  "adders": "<string>",
  "systemSize": "<string>",
  "roofType": "<string>",
  "auroraProjectId": "<string>",
  "enerfloProjectId": "<string>",
  "opensolarProjectId": "<string>",
  "proposalLink": "<string>",
  "battery": "<string>",
  "inverterType": "<string>",
  "moduleType": "<string>",
  "numberOfBatteries": "<string>",
  "numberOfInverters": "<string>",
  "numberOfModules": "<string>",
  "closerName": "<string>",
  "setterName": "<string>",
  "dealer": "<string>",
  "lender": "<string>",
  "loanAmount": "<string>",
  "hoaName": "<string>",
  "hoaEmail": "<string>",
  "hoaNumber": "<string>",
  "notes": "<string>",
  "inspectionNotes": "<string>",
  "reInspectionResults": "<string>",
  "inspectionResults": "<string>",
  "hasBattery": true,
  "hasChangesToAdders": true,
  "hasHoa": true,
  "inspectionRequired": true,
  "installCompleted": true,
  "m2Approved": true,
  "hasOutstandingItems": true,
  "permitRequired": true,
  "plansetMatchesAsBuilt": true,
  "scopeOfWorkPacket": true,
  "hicAgreement": "<string>",
  "lastModified": "2023-11-07T05:31:56Z",
  "createDate": "2023-11-07T05:31:56Z",
  "timeInCurrentStage": "2023-11-07T05:31:56Z",
  "cadCompleted": "2023-11-07T05:31:56Z",
  "cadRequested": "2023-11-07T05:31:56Z",
  "engineeringCompleted": "2023-11-07T05:31:56Z",
  "engineeringRequested": "2023-11-07T05:31:56Z",
  "expectedPermitDeliveryDate": "2023-11-07T05:31:56Z",
  "fundingSubmitted": "2023-11-07T05:31:56Z",
  "hoaApprovedDate": "2023-11-07T05:31:56Z",
  "inspectionRequested": "2023-11-07T05:31:56Z",
  "installComplete": "2023-11-07T05:31:56Z",
  "installedScheduled": "2023-11-07T05:31:56Z",
  "notesLastUpdated": "2023-11-07T05:31:56Z",
  "notesNextActivityDate": "2023-11-07T05:31:56Z",
  "ntpApproved": "2023-11-07T05:31:56Z",
  "ntpRequested": "2023-11-07T05:31:56Z",
  "permitReceived": "2023-11-07T05:31:56Z",
  "permitSubmitted": "2023-11-07T05:31:56Z",
  "reInspectionRequested": "2023-11-07T05:31:56Z",
  "reInstallScheduled": "2023-11-07T05:31:56Z",
  "reSignDate": "2023-11-07T05:31:56Z",
  "siteSurveyCompleted": "2023-11-07T05:31:56Z",
  "siteSurveyRequested": "2023-11-07T05:31:56Z",
  "redesignCompleteDate": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

The ID of the deal

Response

OK

id
integer

The ID of the deal in HubSpot

owner
object | null

The deal's owner / sales representative

projectManager
object | null

The deal's project manager

postInstallEngineer
object | null

The deal's post install engineer

postInstallProjectManager
object | null

The deal's post-install project manager

ixCoordinator
object | null

The deal's IX coordinator

permitCoordinator
object | null

The deal's permit coordinator

dealname
string | null

The deal name

firstName
string | null

Homeowner's first name

lastName
string | null

Homeowner's last name

coordinates
string | null

Homeowner's coordinates

state
string | null

Homeowner's state

streetAddress
string | null

Homeowner's street address

city
string | null

Homeowner's city

zipCode
string | null

Homeowner's zip code

primaryPhone
string | null

Homeowner's primary phone number

nameOnUb
string | null

Homeowner's name on the utility bill

utilityName
string | null

Homeowner's utility name

stage
string | null

The current deal stage

stageId
string | null

The ID of the deal stage

pipelineId
string | null

The pipeline ID the deal is in

pipeline
string | null

The pipeline label the deal is in

amount
number | null

The deal amount

totalPpw
number | null

The deal's total ppw

basePpw
number | null

The base PPW

adderPpw
string | null

The adder PPW

adderCost
number | null

The cost of the adders

adders
string | null

Comma separated list of the adders

systemSize
string | null

The project's system size

roofType
string | null

The project's roof type

auroraProjectId
string | null

The project ID in Aurora

enerfloProjectId
string | null

The project ID in Enerflo

opensolarProjectId
string | null

The project ID in OpenSolar

The proposal link to the design tool

battery
string | null

The name of the battery used

inverterType
string | null

The inverter type used

moduleType
string | null

The module type used

numberOfBatteries
string | null

The quantity of batteries used

numberOfInverters
string | null

The quantity of inverters used

numberOfModules
string | null

The quantity of modules used

closerName
string | null

The deal's closer name

setterName
string | null

The deal's setter name

dealer
string | null

The partner that made closed

lender
string | null

The lender used

loanAmount
string | null

The loan amount

hoaName
string | null

HOA's full name

hoaEmail
string | null

HOA's email

hoaNumber
string | null

HOA's phone number

notes
string | null

The deal notes

inspectionNotes
string | null

The inspection notes

reInspectionResults
string | null

The results of the re-inspection

inspectionResults
string | null

The results of the inspection

hasBattery
boolean

If the project has a battery

hasChangesToAdders
boolean

If there were any new changes to the adders

hasHoa
boolean

If the project has an HOA

inspectionRequired
boolean

If inspection is required

installCompleted
boolean

If install has been completed

m2Approved
boolean

If M2 was approved

hasOutstandingItems
boolean

If the project has outstanding items

permitRequired
boolean

If permit is required

plansetMatchesAsBuilt
boolean

If planset matches as built

scopeOfWorkPacket
boolean

If scope of work packet is completed

hicAgreement
string | null

The ID of the HIC agreement file

lastModified
string<date-time> | null

The timestamp of when the deal was last modified

createDate
string<date-time> | null

The date when the project was created on

timeInCurrentStage
string<date-time> | null

Time the deal has been in the current stage

cadCompleted
string<date-time> | null

Date when CAD was completed

cadRequested
string<date-time> | null

Date when Cad was requested

engineeringCompleted
string<date-time> | null

Date when engineering was completed

engineeringRequested
string<date-time> | null

Date when engineering was requested

expectedPermitDeliveryDate
string<date-time> | null

Date of expected permit delivery

fundingSubmitted
string<date-time> | null

Date when funding was submitted

hoaApprovedDate
string<date-time> | null

Date when HOA was approved

inspectionRequested
string<date-time> | null

Date when inspection was requested

installComplete
string<date-time> | null

Date when install was completed

installedScheduled
string<date-time> | null

Date of when install is scheduled

notesLastUpdated
string<date-time> | null

Date when notes were last updated

notesNextActivityDate
string<date-time> | null

Date of the next activity for notes

ntpApproved
string<date-time> | null

Date when NTP was approved

ntpRequested
string<date-time> | null

Date when NTP was requested

permitReceived
string<date-time> | null

Date when permit was received

permitSubmitted
string<date-time> | null

Date when permit was Submitted

reInspectionRequested
string<date-time> | null

Date when re-inspection was requested

reInstallScheduled
string<date-time> | null

Date when re-install was scheduled

reSignDate
string<date-time> | null

Date of the resign

siteSurveyCompleted
string<date-time> | null

Date when site survey was completed

siteSurveyRequested
string<date-time> | null

Date when site survey was requested

redesignCompleteDate
string<date-time> | null

Date when the redesign was completed

I