COMPANY

Fetches a list of company with filtering, sorting, and pagination options.

GET/api/v2/companies/list

Authentication

Choose one supported method for this request.

OAuth 2.0 client credentials

Parameters

pageNumberqueryinteger · int32

The page number for pagination.

pageSizequeryinteger · int32

The size of the page for pagination.

orderByquerystring

The field to order by.

searchTermquerystring

Search term to filter results(CompanyName or AccountNo).

fieldsquerystring

Specific fields to retrieve.

filterquerystring

"MyFavorites" to show favorites or "MyAssigned" to display assigned companies.

sortOrdersquerystring

Sorting order of results.

colsquerystring

Columns to include in the result.

advancedSearchquerystring

Company advanced search: Fields supported State, City, County, Zip, Status

Responses

Request successful with company data.

Standard response envelopeisSuccessmessageerrorsdata

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

Paginated

totalCountinteger · int32
dataobject[]nullable
pageCountinteger · int32
currentPageCountinteger · int32
nextPageNumberinteger · int32nullable
hasNextPageboolean

REQUEST EXAMPLE

curl --request GET \
  'https://apiv2.crmseries.com/api/v2/companies/list' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

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

RESPONSE · 200

{
  "isSuccess": true,
  "message": "",
  "data": {
    "totalCount": 42,
    "data": [
      {}
    ],
    "pageCount": 42,
    "currentPageCount": 42,
    "nextPageNumber": 1,
    "hasNextPage": true
  },
  "errors": []
}