List companies with license details

As a Reseller you can retrieve all companies you manage with license information: License Type, Target Users, Monthly Users, License Limit, Renewal Date. Use this list to get Company IDs for scoped API calls and for export to CSV/Excel. Use a credential with Client Role = Reseller.

POST /api/companies/search

Retrieves a paginated, filterable, sortable list of all companies with license details. Test it: Authorize with Client ID/Secret, then Send — request body is pre-filled (pageNumber: 1, pageSize: 10, orderBy: CreateTime).

Automation tools (Zapier, Make, scripts): This endpoint requires a non-empty request body. Do not send an empty body or {}. Include at least pageNumber, pageSize, orderBy, ascending, and filter (use the example in the schema below, or filter: { "Condition": "AND", "SearchInputTextValue": "" }). Empty body can cause 500 errors or unreliable results. See Quickstart → Integration and automation for general rules.

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

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

{
  "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-07-10T13:16:45.170Z",
        "createTime": "2026-07-10T13:16:45.170Z",
        "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-07-10T13:16:45.170Z",
            "createTime": "2026-07-10T13:16:45.170Z",
            "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 same list to CSV or Excel for reporting or billing. Test it: Authorize with Client ID/Secret, then Send — request body is pre-filled (minimal pagination + exportType: Csv).

Request body: Send a non-empty body (e.g. pageNumber, pageSize, orderBy, ascending, filter, exportType). Empty body can cause errors in automation tools. Use the schema example below.

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

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

No content

Common errors

403 Forbidden — Credential is not Reseller. Set Client Role = Reseller in Company → Company Settings → REST API.
401 Unauthorized — Missing or invalid token. Request a new token via POST /connect/token.
400 Bad Request — Invalid request body (e.g. missing orderBy). Include pageNumber, pageSize, orderBy, ascending, filter.

Platform UI: View and manage companies in Company → Companies. For billing export, see Export customer list for billing →. Companies →

PreviousScope API requests to a customer NextCreate a company

Last updated 3 months ago