Deals

List Deals

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · int32 · min: 1Optional

perPageinteger · int32 · min: 1 · max: 100Optional

querystringOptional

sortstringOptional

sortDirstring · enumOptionalPossible values:

Responses

200

List of deals

application/json

totalRowsnumberOptional

pagenumberOptional

perPagenumberOptional

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/deals

HTTPcURLJavaScriptPython

GET /v2/deals HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "totalRows": 1,
  "page": 1,
  "perPage": 1,
  "rows": [
    {
      "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
      "name": "New Deal",
      "contact": {
        "firstName": "Alice",
        "lastName": "Smith",
        "email": "[e-mail]"
      },
      "jobAddress": {
        "address": "123 Main St",
        "city": "Springfield",
        "state": "IL",
        "zip": "62701"
      },
      "pipeline": "sales-pipeline",
      "stage": "initial-contact",
      "leadSource": "Website",
      "linkedEstimateIds": [
        "estimate-123"
      ],
      "linkedInvoiceIds": [
        "invoice-321"
      ]
    }
  ]
}

Create Deal

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

idstring · uuidOptional

The unique ID for the Deal. Ignored when creating & updating deals.

namestring · nullableOptional

The Name of the Deal.

pipelinestring · nullableOptional

The pipeline this Deal is in

stagestring · nullableOptional

The stage of the pipeline this Deal is in

valuenumber · float · nullableOptional

The monetary value of this Deal

leadSourcestring · nullableOptional

The lead source of this Deal

tagsstring[]Optional

Tags associated with this Deal

linkedEstimateIdsstring[]Optional

List of linked Estimate IDs

linkedInvoiceIdsstring[]Optional

List of linked Invoice IDs

Responses

200

Details about the new Deal

application/json

idstring · uuidOptional

The unique ID for the Deal. Ignored when creating & updating deals.

namestring · nullableOptional

The Name of the Deal.

pipelinestring · nullableOptional

The pipeline this Deal is in

stagestring · nullableOptional

The stage of the pipeline this Deal is in

valuenumber · float · nullableOptional

The monetary value of this Deal

leadSourcestring · nullableOptional

The lead source of this Deal

tagsstring[]Optional

Tags associated with this Deal

linkedEstimateIdsstring[]Optional

List of linked Estimate IDs

linkedInvoiceIdsstring[]Optional

List of linked Invoice IDs

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

post/deals

HTTPcURLJavaScriptPython

POST /v2/deals HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 384

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "name": "New Deal",
  "contact": {
    "firstName": "Alice",
    "lastName": "Smith",
    "email": "[e-mail]"
  },
  "jobAddress": {
    "address": "123 Main St",
    "city": "Springfield",
    "state": "IL",
    "zip": "62701"
  },
  "pipeline": "sales-pipeline",
  "stage": "initial-contact",
  "leadSource": "Website",
  "linkedEstimateIds": [
    "estimate-123"
  ],
  "linkedInvoiceIds": [
    "invoice-321"
  ]
}

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "name": "New Deal",
  "contact": {
    "firstName": "Alice",
    "lastName": "Smith",
    "email": "[e-mail]"
  },
  "jobAddress": {
    "address": "123 Main St",
    "city": "Springfield",
    "state": "IL",
    "zip": "62701"
  },
  "pipeline": "sales-pipeline",
  "stage": "initial-contact",
  "leadSource": "Website",
  "linkedEstimateIds": [
    "estimate-123"
  ],
  "linkedInvoiceIds": [
    "invoice-321"
  ]
}

Retrieve Deal

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Deal

Responses

200

Details about the deal

application/json

idstring · uuidOptional

The unique ID for the Deal. Ignored when creating & updating deals.

namestring · nullableOptional

The Name of the Deal.

pipelinestring · nullableOptional

The pipeline this Deal is in

stagestring · nullableOptional

The stage of the pipeline this Deal is in

valuenumber · float · nullableOptional

The monetary value of this Deal

leadSourcestring · nullableOptional

The lead source of this Deal

tagsstring[]Optional

Tags associated with this Deal

linkedEstimateIdsstring[]Optional

List of linked Estimate IDs

linkedInvoiceIdsstring[]Optional

List of linked Invoice IDs

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/deals/{id}

HTTPcURLJavaScriptPython

GET /v2/deals/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "name": "New Deal",
  "contact": {
    "firstName": "Alice",
    "lastName": "Smith",
    "email": "[e-mail]"
  },
  "jobAddress": {
    "address": "123 Main St",
    "city": "Springfield",
    "state": "IL",
    "zip": "62701"
  },
  "pipeline": "sales-pipeline",
  "stage": "initial-contact",
  "leadSource": "Website",
  "linkedEstimateIds": [
    "estimate-123"
  ],
  "linkedInvoiceIds": [
    "invoice-321"
  ]
}

Update Deal

put

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Deal

Body

application/json

namestring · nullableOptional

The Name of the Deal.

pipelinestring · nullableOptional

The pipeline this Deal is in

stagestring · nullableOptional

The stage of the pipeline this Deal is in

leadSourcestring · nullableOptional

The lead source of this Deal

tagsstring[]Optional

Tags associated with this Deal

Responses

200

The updated deal

application/json

idstring · uuidOptional

The unique ID for the Deal. Ignored when creating & updating deals.

namestring · nullableOptional

The Name of the Deal.

pipelinestring · nullableOptional

The pipeline this Deal is in

stagestring · nullableOptional

The stage of the pipeline this Deal is in

valuenumber · float · nullableOptional

The monetary value of this Deal

leadSourcestring · nullableOptional

The lead source of this Deal

tagsstring[]Optional

Tags associated with this Deal

linkedEstimateIdsstring[]Optional

List of linked Estimate IDs

linkedInvoiceIdsstring[]Optional

List of linked Invoice IDs

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

put/deals/{id}

HTTPcURLJavaScriptPython

PUT /v2/deals/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 268

{
  "name": "New Deal",
  "contact": {
    "firstName": "Alice",
    "lastName": "Smith",
    "email": "[e-mail]"
  },
  "jobAddress": {
    "address": "123 Main St",
    "city": "Springfield",
    "state": "IL",
    "zip": "62701"
  },
  "pipeline": "sales-pipeline",
  "stage": "initial-contact",
  "leadSource": "Website"
}

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "name": "New Deal",
  "contact": {
    "firstName": "Alice",
    "lastName": "Smith",
    "email": "[e-mail]"
  },
  "jobAddress": {
    "address": "123 Main St",
    "city": "Springfield",
    "state": "IL",
    "zip": "62701"
  },
  "pipeline": "sales-pipeline",
  "stage": "initial-contact",
  "leadSource": "Website",
  "linkedEstimateIds": [
    "estimate-123"
  ],
  "linkedInvoiceIds": [
    "invoice-321"
  ]
}

Delete Deal

delete

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Deal

Responses

204

No Content

No content

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

delete/deals/{id}

HTTPcURLJavaScriptPython

DELETE /v2/deals/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content