Get total monthly user count across customers

As a Reseller you get the total monthly user count across all companies you manage for billing or capacity reporting. Use a credential with Client Role = Reseller. Call company search (with a month parameter if the API supports it for Monthly Users), then sum the monthly user value from each company in the response. Paginate through all pages to include every company, or export to CSV/Excel and sum the monthly user column client-side.

---

POST /api/companies/search

Returns a paginated list of companies; each item includes a monthly user count for the selected period. Request body: see Endpoints → Company (e.g. month selector or date range if available for Monthly Users). To get the total monthly user count: call search with a large pageSize or loop through all pages and sum the monthly user field from each company. The response total count and items give you the full set to aggregate.

Retrieves a list of all companies with license details, including monthly user count per company. Sum the monthly user values across all pages to get the total for billing.

Retrieves a list of all companies

post

Required scopes

This endpoint requires the following scopes:

• : API

Authorizations

OAuth2clientCredentialsRequired

Client ID and Client Secret from Company → Company Settings → REST API. Enter credentials to auto-fetch token.

Token URL:

Body

pageNumberintegerRequiredExample: 1

pageSizeintegerRequiredExample: 10

orderBystringRequiredExample: CreateTime

ascendingbooleanRequiredExample: false

isTargetUserCountExceededLimitbooleanOptional

If true, only companies exceeding license limit are returned

Example: false

Responses

200

OK

application/json

statusstringOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

post/api/companies/search

POST /api/companies/search HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 126

{
  "pageNumber": 1,
  "pageSize": 10,
  "orderBy": "CreateTime",
  "ascending": false,
  "filter": {
    "Condition": "AND",
    "SearchInputTextValue": ""
  }
}

200

OK

{
  "data": {
    "limitExceededCompanyCount": 1,
    "pageNumber": 1,
    "pageSize": 1,
    "totalNumberOfPages": 1,
    "totalNumberOfRecords": 1,
    "results": [
      {
        "companyName": "text",
        "companyResourceId": "text",
        "resellerName": "text",
        "industryName": "text",
        "industryResourceId": "text",
        "licenseTypeName": "text",
        "licenseTypeResourceId": "text",
        "isNumberOfUsersLimited": true,
        "numberOfUsers": "text",
        "privacyDurationId": 1,
        "licenceExpired": true,
        "licenseEndDate": "2026-01-01T00:00:00.000Z",
        "createTime": "2026-01-01T00:00:00.000Z",
        "targetUserCount": 1,
        "children": [
          {
            "companyName": "text",
            "companyResourceId": "text",
            "resellerName": "text",
            "industryName": "text",
            "industryResourceId": "text",
            "licenseTypeName": "text",
            "licenseTypeResourceId": "text",
            "isNumberOfUsersLimited": true,
            "numberOfUsers": "text",
            "privacyDurationId": 1,
            "licenceExpired": true,
            "licenseEndDate": "2026-01-01T00:00:00.000Z",
            "createTime": "2026-01-01T00:00:00.000Z",
            "targetUserCount": 1,
            "children": "[Circular Reference]",
            "tags": [
              "text"
            ],
            "deletedTargetUserCount": 1,
            "inactiveTargetUserCount": 1,
            "monthlyActiveUserCount": 1
          }
        ],
        "tags": [
          "text"
        ],
        "deletedTargetUserCount": 1,
        "inactiveTargetUserCount": 1,
        "monthlyActiveUserCount": 1
      }
    ]
  },
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

---

POST /api/companies/search/export

Exports the company list to CSV or Excel including the monthly user column. Sum that column in your spreadsheet or script to get the total monthly user count for billing. Use the same request parameters as in the UI month selector if the API supports a month or date range for Monthly Users.

Exports the list of companies to CSV or Excel. Use the monthly user column to compute the total monthly user count for billing.

Exports the list of companies

post

Required scopes

This endpoint requires the following scopes:

• : API

Authorizations

OAuth2clientCredentialsRequired

Client ID and Client Secret from Company → Company Settings → REST API. Enter credentials to auto-fetch token.

Token URL:

Body

pageNumberintegerRequiredExample: 1

pageSizeintegerRequiredExample: 10

orderBystringRequiredExample: CreateTime

ascendingbooleanRequiredExample: false

isClusteredbooleanOptionalExample: false

isTargetUserCountExceededLimitbooleanOptional

If true, export only companies exceeding license limit

Example: false

reportAllPagesbooleanOptionalExample: false

exportTypestringRequiredExample: CSV

Responses

200

OK

No content

post/api/companies/search/export

POST /api/companies/search/export HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 227

{
  "pageNumber": 1,
  "pageSize": 10,
  "orderBy": "CreateTime",
  "ascending": false,
  "isClustered": false,
  "isTargetUserCountExceededLimit": false,
  "reportAllPages": false,
  "exportType": "CSV",
  "filter": {
    "Condition": "AND",
    "SearchInputTextValue": ""
  }
}

200

OK

No content

---

Common errors

• 403 Forbidden — Credential is not Reseller. Set Client Role = Reseller in Company → Company Settings → REST API. Roles and permissions →

• 401 Unauthorized — Missing or invalid token. Request a new token via POST /connect/token.

• 400 Bad Request — Invalid request body. Include pageNumber, pageSize, orderBy, ascending; add any month or date parameter required for Monthly Users per Endpoints → Company.

Related: Export customer list for billing →. List companies with license details →. Scope API requests to a customer →.