REPORTING

Retrieves a Company report filtered by any combination of the supplied criteria.

All filter fields are optional; only the fields present in the request are applied. Filters include company name, account number, state, county, and zip (each matched individually), plus branches, sales reps, categories, and ranks (each matched as an array).

POST/api/v2/reporting/companies

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Request body

application/jsonrequired

Filter and pagination criteria for the report. PageSize is capped at 100 regardless of the value supplied.

companyNamestringnullable
accountNostringnullable
branchesstring[]nullable
salesRepsstring[]nullable
categoriesstring[]nullable
ranksstring[]nullable
statestringnullable
countystringnullable
zipstringnullable
pageNumberinteger · int32
pageSizeinteger · int32

Responses

Standard response envelopeisSuccessmessageerrorsdata

Read the result from data. When isSuccess is false, errors lists what went wrong. Handling errors

Paginated

totalCountinteger · int32
- companyIdinteger · int32
- companyNamestring
- legalNamestring
- statusstring
- address1string
- address2string
- citystring
- statestring
- zipstring
- phonestring
- faxstring
- accountNostring
- countystring
- countrystring
- recordTypestring
- branchstring
- sourcestring
- assignedRepsstring
- categorystring
- equipmentCountinteger · int32
- rankstring
- lastTouchstring · date-timenullable
- lastTouchUserstring
- erpCompanyCodestring
pageCountinteger · int32
currentPageCountinteger · int32
nextPageNumberinteger · int32nullable
hasNextPageboolean

REQUEST EXAMPLE

curl --request POST \
  'https://apiv2.crmseries.com/api/v2/reporting/companies' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "companyName": "Acme Equipment Co.",
    "accountNo": "string",
    "branches": [
      "string"
    ],
    "salesReps": [
      "string"
    ],
    "categories": [
      "string"
    ],
    "ranks": [
      "string"
    ],
    "state": "IL",
    "county": "Cook",
    "zip": "60601",
    "pageNumber": 1,
    "pageSize": 25
  }'

Replace the uppercase placeholders and sample values with your integration values.

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": {
    "totalCount": 42,
    "data": [
      {
        "companyId": 1024,
        "companyName": "Acme Equipment Co.",
        "legalName": "Acme Equipment Co.",
        "status": "string",
        "address1": "100 Main St",
        "address2": "100 Main St",
        "city": "Chicago",
        "state": "IL",
        "zip": "60601",
        "phone": "555-0100",
        "fax": "555-0100",
        "accountNo": "string",
        "county": "Cook",
        "country": "US",
        "recordType": "string",
        "branch": "string",
        "source": "string",
        "assignedReps": "string",
        "category": "string",
        "equipmentCount": 42,
        "rank": "string",
        "lastTouch": "2026-01-15T14:30:00Z",
        "lastTouchUser": "string",
        "erpCompanyCode": "string"
      }
    ],
    "pageCount": 42,
    "currentPageCount": 42,
    "nextPageNumber": 1,
    "hasNextPage": true
  },
  "errors": []
}