REPORTING

Retrieves a paginated Lead 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 owners, statuses, branches, and sources (each matched as an array), plus assigned/acknowledged/converted date ranges.

POST/api/v2/reporting/leads

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.

ownersstring[]nullable
statusesstring[]nullable
branchesstring[]nullable
sourcesstring[]nullable
dateAssignedFromstring · date-timenullable
dateAssignedTostring · date-timenullable
dateAcknowledgedFromstring · date-timenullable
dateAcknowledgedTostring · date-timenullable
dateConvertedFromstring · date-timenullable
dateConvertedTostring · date-timenullable
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
- leadIdinteger · int32
- companyIdinteger · int32
- contactIdinteger · int32
- ownerIdinteger · int32
- descriptionstring
- commentsstring
- dateEnteredstring · date-timenullable
- dateAssignedstring · date-timenullable
- dateAcknowledgedstring · date-timenullable
- dateConvertedstring · date-timenullable
- sourcestring
- sourceLocationstring
- reasonstring
- statusstring
- ownerstring
- companyNamestring
- contactstring
- citystring
- statestring
- zipstring
- countystring
- branchstring
- makestring
- modelstring
- equipmentTypestring
pageCountinteger · int32
currentPageCountinteger · int32
nextPageNumberinteger · int32nullable
hasNextPageboolean

REQUEST EXAMPLE

curl --request POST \
  'https://apiv2.crmseries.com/api/v2/reporting/leads' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
  --header 'Content-Type: application/json' \
  --data '{
    "owners": [
      "string"
    ],
    "statuses": [
      "string"
    ],
    "branches": [
      "string"
    ],
    "sources": [
      "string"
    ],
    "dateAssignedFrom": "2026-01-15T14:30:00Z",
    "dateAssignedTo": "2026-01-15T14:30:00Z",
    "dateAcknowledgedFrom": "2026-01-15T14:30:00Z",
    "dateAcknowledgedTo": "2026-01-15T14:30:00Z",
    "dateConvertedFrom": "2026-01-15T14:30:00Z",
    "dateConvertedTo": "2026-01-15T14:30:00Z",
    "pageNumber": 1,
    "pageSize": 25
  }'

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

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": {
    "totalCount": 42,
    "data": [
      {
        "leadId": 1024,
        "companyId": 1024,
        "contactId": 1024,
        "ownerId": 1024,
        "description": "string",
        "comments": "string",
        "dateEntered": "2026-01-15T14:30:00Z",
        "dateAssigned": "2026-01-15T14:30:00Z",
        "dateAcknowledged": "2026-01-15T14:30:00Z",
        "dateConverted": "2026-01-15T14:30:00Z",
        "source": "string",
        "sourceLocation": "string",
        "reason": "string",
        "status": "string",
        "owner": "string",
        "companyName": "Acme Equipment Co.",
        "contact": "string",
        "city": "Chicago",
        "state": "IL",
        "zip": "60601",
        "county": "Cook",
        "branch": "string",
        "make": "Caterpillar",
        "model": "320",
        "equipmentType": "string"
      }
    ],
    "pageCount": 42,
    "currentPageCount": 42,
    "nextPageNumber": 1,
    "hasNextPage": true
  },
  "errors": []
}