Companies

List Companies

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 companies

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/companies

HTTPcURLJavaScriptPython

GET /v2/companies 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": "Bobs Plumbing",
      "email": "[e-mail]",
      "phoneNumber": "5551234567"
    }
  ]
}

Create Company

post

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

idstringOptional

The unique ID of the Company. Ignord when creating & updating companies

namestring · nullableOptional

The Name of the Company.

emailstring · nullableOptional

The email address of this Company

phoneNumberstring · nullableOptional

The phone number of this Company

phoneNumberExtstring · nullableOptional

The phone number extension of this Company

addressstring · nullableOptional

The address of this Company

citystring · nullableOptional

The city of this Company

statestring · nullableOptional

The state of this Company

zipstring · nullableOptional

The zip or postal code of this Company

leadSourcestring · nullableOptional

The lead source of this Company

tagsstring[]Optional

Tags associated with this Company

Responses

200

Details about the new Company

application/json

idstringOptional

The unique ID of the Company. Ignord when creating & updating companies

namestring · nullableOptional

The Name of the Company.

emailstring · nullableOptional

The email address of this Company

phoneNumberstring · nullableOptional

The phone number of this Company

phoneNumberExtstring · nullableOptional

The phone number extension of this Company

addressstring · nullableOptional

The address of this Company

citystring · nullableOptional

The city of this Company

statestring · nullableOptional

The state of this Company

zipstring · nullableOptional

The zip or postal code of this Company

leadSourcestring · nullableOptional

The lead source of this Company

tagsstring[]Optional

Tags associated with this Company

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

post/companies

HTTPcURLJavaScriptPython

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

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "name": "Bobs Plumbing",
  "email": "[e-mail]",
  "phoneNumber": "5551234567"
}

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "name": "Bobs Plumbing",
  "email": "[e-mail]",
  "phoneNumber": "5551234567"
}

Retrieve Company

get

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Company

Responses

200

Details about the company

application/json

idstringOptional

The unique ID of the Company. Ignord when creating & updating companies

namestring · nullableOptional

The Name of the Company.

emailstring · nullableOptional

The email address of this Company

phoneNumberstring · nullableOptional

The phone number of this Company

phoneNumberExtstring · nullableOptional

The phone number extension of this Company

addressstring · nullableOptional

The address of this Company

citystring · nullableOptional

The city of this Company

statestring · nullableOptional

The state of this Company

zipstring · nullableOptional

The zip or postal code of this Company

leadSourcestring · nullableOptional

The lead source of this Company

tagsstring[]Optional

Tags associated with this Company

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/companies/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "name": "Bobs Plumbing",
  "email": "[e-mail]",
  "phoneNumber": "5551234567"
}

Update Company

put

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Company

Body

application/json

idstringOptional

The unique ID of the Company. Ignord when creating & updating companies

namestring · nullableOptional

The Name of the Company.

emailstring · nullableOptional

The email address of this Company

phoneNumberstring · nullableOptional

The phone number of this Company

phoneNumberExtstring · nullableOptional

The phone number extension of this Company

addressstring · nullableOptional

The address of this Company

citystring · nullableOptional

The city of this Company

statestring · nullableOptional

The state of this Company

zipstring · nullableOptional

The zip or postal code of this Company

leadSourcestring · nullableOptional

The lead source of this Company

tagsstring[]Optional

Tags associated with this Company

Responses

200

The updated company

application/json

idstringOptional

The unique ID of the Company. Ignord when creating & updating companies

namestring · nullableOptional

The Name of the Company.

emailstring · nullableOptional

The email address of this Company

phoneNumberstring · nullableOptional

The phone number of this Company

phoneNumberExtstring · nullableOptional

The phone number extension of this Company

addressstring · nullableOptional

The address of this Company

citystring · nullableOptional

The city of this Company

statestring · nullableOptional

The state of this Company

zipstring · nullableOptional

The zip or postal code of this Company

leadSourcestring · nullableOptional

The lead source of this Company

tagsstring[]Optional

Tags associated with this Company

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

put/companies/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "name": "Bobs Plumbing",
  "email": "[e-mail]",
  "phoneNumber": "5551234567"
}

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "name": "Bobs Plumbing",
  "email": "[e-mail]",
  "phoneNumber": "5551234567"
}

Delete Company

delete

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Company

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/companies/{id}

HTTPcURLJavaScriptPython

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

No content