Companies
Page number to fetch, 1-indexed. Defaults to 1.
Number of results per page (1-100). Defaults to the API's standard page size if omitted.
Lucene-style filter query (e.g. status:active AND createdAt:[2024-01-01 TO *]). Field names match the Company object's own fields. This syntax is part of an in-flight migration (see docs/design/lucene-migration-json-filter-spec.md) and may change.
Field name to sort by - any top-level field of the Company object returned by this endpoint. Defaults to the API's natural order if omitted.
Sort direction: asc or desc. Only takes effect when sort is set.
List of companies
Bad Request
Not Authorized
Not found
Unexpected error
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": "bob@bobsplumbing.com",
"phoneNumber": "5551234567"
}
]
}The unique ID of the Company. Ignord when creating & updating companies
The Name of the Company.
The email address of this Company
The phone number of this Company
The phone number extension of this Company
The address of this Company
The city of this Company
The state of this Company
The zip or postal code of this Company
The lead source of this Company
Tags associated with this Company
Details about the new Company
The unique ID of the Company. Ignord when creating & updating companies
The Name of the Company.
The email address of this Company
The phone number of this Company
The phone number extension of this Company
The address of this Company
The city of this Company
The state of this Company
The zip or postal code of this Company
The lead source of this Company
Tags associated with this Company
Bad Request
Not Authorized
Not found
Unexpected error
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": "bob@bobsplumbing.com",
"phoneNumber": "5551234567"
}{
"id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
"name": "Bobs Plumbing",
"email": "bob@bobsplumbing.com",
"phoneNumber": "5551234567"
}ID of the Company
Details about the company
The unique ID of the Company. Ignord when creating & updating companies
The Name of the Company.
The email address of this Company
The phone number of this Company
The phone number extension of this Company
The address of this Company
The city of this Company
The state of this Company
The zip or postal code of this Company
The lead source of this Company
Tags associated with this Company
Bad Request
Not Authorized
Not found
Unexpected error
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": "bob@bobsplumbing.com",
"phoneNumber": "5551234567"
}ID of the Company
The unique ID of the Company. Ignord when creating & updating companies
The Name of the Company.
The email address of this Company
The phone number of this Company
The phone number extension of this Company
The address of this Company
The city of this Company
The state of this Company
The zip or postal code of this Company
The lead source of this Company
Tags associated with this Company
The updated company
The unique ID of the Company. Ignord when creating & updating companies
The Name of the Company.
The email address of this Company
The phone number of this Company
The phone number extension of this Company
The address of this Company
The city of this Company
The state of this Company
The zip or postal code of this Company
The lead source of this Company
Tags associated with this Company
Bad Request
Not Authorized
Not found
Unexpected error
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": "bob@bobsplumbing.com",
"phoneNumber": "5551234567"
}{
"id": "abcd1234-abcd-1234-abcd-abcd1234abcd",
"name": "Bobs Plumbing",
"email": "bob@bobsplumbing.com",
"phoneNumber": "5551234567"
}ID of the Company
No Content
No content
Bad Request
Not Authorized
Not found
Unexpected error
DELETE /v2/companies/{id} HTTP/1.1
Host: openapi.paintscout.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
No content
Last updated
Was this helpful?