Contacts

List Contacts

get

Authorizations

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 contacts

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

GET /v2/contacts 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",
      "firstName": "Bob",
      "lastName": "Johnson",
      "company": "Johnson Construction",
      "email": "bob@johnsonconstruction.com",
      "phoneNumber": "5551234567"
    }
  ]
}

Create Contact

post

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

idstringOptional

The unique ID of the Contact. Ignored when creating & updating contacts

firstNamestring · nullableOptional

The First Name of the Contact.

lastNamestring · nullableOptional

The Last Name of the Contact

secondaryFirstNamestring · nullableOptional

The secondary First Name of the Contact

secondaryLastNamestring · nullableOptional

The secondary Last Name of the Contact

companystring · nullableOptional

The name of the Company this Contact is associated with

emailstring · nullableOptional

The email address of this Contact

alternateEmailstring · nullableOptional

The alternate email address of this Contact

phoneNumberstring · nullableOptional

The phone number of this Contact

phoneNumberExtstring · nullableOptional

The phone number extension of this Contact

alternatePhoneNumberstring · nullableOptional

The alternate phone number of this Contact

alternatePhoneNumberExtstring · nullableOptional

The alternate phone number extension of this Contact

preferredContactMethodstring · nullableOptional

The preferred contact method for this Contact

addressstring · nullableOptional

The address of this Contact

citystring · nullableOptional

The city of this Contact

statestring · nullableOptional

The state of this Contact

zipstring · nullableOptional

The zip or postal code of this Contact

leadSourcestring · nullableOptional

The lead source of this Contact

notestring · nullableOptional

A note about this Contact

tagsstring[]Optional

Tags associated with this Contact

Responses

200

Details about the new Contact

application/json

idstringOptional

The unique ID of the Contact. Ignored when creating & updating contacts

firstNamestring · nullableOptional

The First Name of the Contact.

lastNamestring · nullableOptional

The Last Name of the Contact

secondaryFirstNamestring · nullableOptional

The secondary First Name of the Contact

secondaryLastNamestring · nullableOptional

The secondary Last Name of the Contact

companystring · nullableOptional

The name of the Company this Contact is associated with

emailstring · nullableOptional

The email address of this Contact

alternateEmailstring · nullableOptional

The alternate email address of this Contact

phoneNumberstring · nullableOptional

The phone number of this Contact

phoneNumberExtstring · nullableOptional

The phone number extension of this Contact

alternatePhoneNumberstring · nullableOptional

The alternate phone number of this Contact

alternatePhoneNumberExtstring · nullableOptional

The alternate phone number extension of this Contact

preferredContactMethodstring · nullableOptional

The preferred contact method for this Contact

addressstring · nullableOptional

The address of this Contact

citystring · nullableOptional

The city of this Contact

statestring · nullableOptional

The state of this Contact

zipstring · nullableOptional

The zip or postal code of this Contact

leadSourcestring · nullableOptional

The lead source of this Contact

notestring · nullableOptional

A note about this Contact

tagsstring[]Optional

Tags associated with this Contact

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

post/contacts

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

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "firstName": "Bob",
  "lastName": "Johnson",
  "company": "Johnson Construction",
  "email": "bob@johnsonconstruction.com",
  "phoneNumber": "5551234567"
}

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "firstName": "Bob",
  "lastName": "Johnson",
  "company": "Johnson Construction",
  "email": "bob@johnsonconstruction.com",
  "phoneNumber": "5551234567"
}

Retrieve Contact

get

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Contact

Responses

200

Details about the contact

application/json

idstringOptional

The unique ID of the Contact. Ignored when creating & updating contacts

firstNamestring · nullableOptional

The First Name of the Contact.

lastNamestring · nullableOptional

The Last Name of the Contact

secondaryFirstNamestring · nullableOptional

The secondary First Name of the Contact

secondaryLastNamestring · nullableOptional

The secondary Last Name of the Contact

companystring · nullableOptional

The name of the Company this Contact is associated with

emailstring · nullableOptional

The email address of this Contact

alternateEmailstring · nullableOptional

The alternate email address of this Contact

phoneNumberstring · nullableOptional

The phone number of this Contact

phoneNumberExtstring · nullableOptional

The phone number extension of this Contact

alternatePhoneNumberstring · nullableOptional

The alternate phone number of this Contact

alternatePhoneNumberExtstring · nullableOptional

The alternate phone number extension of this Contact

preferredContactMethodstring · nullableOptional

The preferred contact method for this Contact

addressstring · nullableOptional

The address of this Contact

citystring · nullableOptional

The city of this Contact

statestring · nullableOptional

The state of this Contact

zipstring · nullableOptional

The zip or postal code of this Contact

leadSourcestring · nullableOptional

The lead source of this Contact

notestring · nullableOptional

A note about this Contact

tagsstring[]Optional

Tags associated with this Contact

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

get/contacts/{id}

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

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "firstName": "Bob",
  "lastName": "Johnson",
  "company": "Johnson Construction",
  "email": "bob@johnsonconstruction.com",
  "phoneNumber": "5551234567"
}

Update Contact

put

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Contact

Body

idstringOptional

The unique ID of the Contact. Ignored when creating & updating contacts

firstNamestring · nullableOptional

The First Name of the Contact.

lastNamestring · nullableOptional

The Last Name of the Contact

secondaryFirstNamestring · nullableOptional

The secondary First Name of the Contact

secondaryLastNamestring · nullableOptional

The secondary Last Name of the Contact

companystring · nullableOptional

The name of the Company this Contact is associated with

emailstring · nullableOptional

The email address of this Contact

alternateEmailstring · nullableOptional

The alternate email address of this Contact

phoneNumberstring · nullableOptional

The phone number of this Contact

phoneNumberExtstring · nullableOptional

The phone number extension of this Contact

alternatePhoneNumberstring · nullableOptional

The alternate phone number of this Contact

alternatePhoneNumberExtstring · nullableOptional

The alternate phone number extension of this Contact

preferredContactMethodstring · nullableOptional

The preferred contact method for this Contact

addressstring · nullableOptional

The address of this Contact

citystring · nullableOptional

The city of this Contact

statestring · nullableOptional

The state of this Contact

zipstring · nullableOptional

The zip or postal code of this Contact

leadSourcestring · nullableOptional

The lead source of this Contact

notestring · nullableOptional

A note about this Contact

tagsstring[]Optional

Tags associated with this Contact

Responses

200

The updated contact

application/json

idstringOptional

The unique ID of the Contact. Ignored when creating & updating contacts

firstNamestring · nullableOptional

The First Name of the Contact.

lastNamestring · nullableOptional

The Last Name of the Contact

secondaryFirstNamestring · nullableOptional

The secondary First Name of the Contact

secondaryLastNamestring · nullableOptional

The secondary Last Name of the Contact

companystring · nullableOptional

The name of the Company this Contact is associated with

emailstring · nullableOptional

The email address of this Contact

alternateEmailstring · nullableOptional

The alternate email address of this Contact

phoneNumberstring · nullableOptional

The phone number of this Contact

phoneNumberExtstring · nullableOptional

The phone number extension of this Contact

alternatePhoneNumberstring · nullableOptional

The alternate phone number of this Contact

alternatePhoneNumberExtstring · nullableOptional

The alternate phone number extension of this Contact

preferredContactMethodstring · nullableOptional

The preferred contact method for this Contact

addressstring · nullableOptional

The address of this Contact

citystring · nullableOptional

The city of this Contact

statestring · nullableOptional

The state of this Contact

zipstring · nullableOptional

The zip or postal code of this Contact

leadSourcestring · nullableOptional

The lead source of this Contact

notestring · nullableOptional

A note about this Contact

tagsstring[]Optional

Tags associated with this Contact

400

Bad Request

application/json

401

Not Authorized

application/json

404

Not found

application/json

500

Unexpected error

application/json

put/contacts/{id}

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

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "firstName": "Bob",
  "lastName": "Johnson",
  "company": "Johnson Construction",
  "email": "bob@johnsonconstruction.com",
  "phoneNumber": "5551234567"
}

{
  "id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
  "firstName": "Bob",
  "lastName": "Johnson",
  "company": "Johnson Construction",
  "email": "bob@johnsonconstruction.com",
  "phoneNumber": "5551234567"
}

Delete Contact

delete

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

idstringRequired

ID of the Contact

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

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

No content

Last updated 18 days ago

Was this helpful?