List and manage company groups

List, search, export, create, and update company groups and their participants. Reseller-only — use a credential with Client Role = Reseller. Participants = the companies that belong to the group (company resourceId list). Company groups let you share training content, notification templates, and custom roles across multiple customer companies.

---

GET /api/company-groups

Retrieves all company groups. No request body. Test it: Authorize with Client ID/Secret, then Send.

Retrieves all company groups

get

Required scopes

This endpoint requires the following scopes:

• : API

Authorizations

oauth2bearerAuth

OAuth2clientCredentialsRequired

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

Token URL:

Responses

200

OK

application/json

statusstringOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

get

/api/company-groups

HTTPcURLJavaScriptPython

GET /api/company-groups HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

OK

{
  "data": [
    {
      "resourceId": "text",
      "name": "text",
      "addedTime": "2026-03-09T12:56:28.657Z",
      "companyCount": 1
    }
  ],
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

---

POST /api/company-groups/search

Searches company groups with pagination and sorting. Test it: Authorize with Client ID/Secret, then Send — request body is pre-filled (pageNumber: 1, pageSize: 10, orderBy: CreateTime).

Searchs company groups of company

post

Required scopes

This endpoint requires the following scopes:

• : API

Authorizations

oauth2bearerAuth

OAuth2clientCredentialsRequired

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

Token URL:

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

pageNumberintegerRequiredExample: 1

pageSizeintegerRequiredExample: 10

orderBystringRequiredExample: CreateTime

ascendingbooleanRequiredExample: false

filterobject · nullableOptional

Responses

200

OK

application/json

statusstringOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

post

/api/company-groups/search

HTTPcURLJavaScriptPython

POST /api/company-groups/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": ""
  }
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "data": {
    "pageNumber": 1,
    "pageSize": 1,
    "totalNumberOfPages": 1,
    "totalNumberOfRecords": 1,
    "results": [
      {
        "resourceId": "text",
        "name": "text",
        "companyCount": 1,
        "createTime": "2026-03-09T12:56:28.657Z"
      }
    ]
  },
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

---

POST /api/company-groups/search/export

Exports the list of company groups to CSV or Excel. Test it: Authorize with Client ID/Secret, then Send — request body is pre-filled (minimal pagination + exportType: Csv).

Exports the list of company groups

post

Required scopes

This endpoint requires the following scopes:

• : API

Authorizations

oauth2bearerAuth

OAuth2clientCredentialsRequired

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

Token URL:

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

pageNumberintegerRequiredExample: 1

pageSizeintegerRequiredExample: 10

orderBystringRequiredExample: CreateTime

ascendingbooleanRequiredExample: false

filterobject · nullableOptional

reportAllPagesbooleanOptionalExample: false

exportTypestringRequiredExample: CSV

Responses

200

OK

No content

post

/api/company-groups/search/export

HTTPcURLJavaScriptPython

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

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

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

No content

---

GET /api/company-groups/{resourceId}

Retrieves a single company group by ID. Replace {resourceId} with the group resource ID from search or list.

Retrieves an existing company group

get

Required scopes

This endpoint requires the following scopes:

• : API

Authorizations

oauth2bearerAuth

OAuth2clientCredentialsRequired

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

Token URL:

Path parameters

resourceIdstringRequired

Responses

200

OK

application/json

statusstringOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

get

/api/company-groups/{resourceId}

HTTPcURLJavaScriptPython

GET /api/company-groups/{resourceId} HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

200

OK

{
  "data": {
    "resourceId": "text",
    "name": "text",
    "addedTime": "2026-03-09T12:56:28.657Z",
    "companyCount": 1
  },
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

---

POST /api/company-groups

Creates a new company group. Send name and optionally companyResourceIdArray (company IDs to add as participants). Test it: Endpoints → CompanyGroup — use dummy name (e.g. "Demo Group") and placeholder IDs (H8d).

Creates a new company group

post

Required scopes

This endpoint requires the following scopes:

• : API

Authorizations

oauth2bearerAuth

OAuth2clientCredentialsRequired

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

Token URL:

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

namestring · min: 1 · max: 64Required

A group name

companyResourceIdArraystring[] · nullableOptional

Array of company resourceIds will be added to the group

Responses

200

OK

application/json

statusstringOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

post

/api/company-groups

HTTPcURLJavaScriptPython

POST /api/company-groups HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 49

{
  "name": "text",
  "companyResourceIdArray": [
    "text"
  ]
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "data": {
    "resourceId": "text"
  },
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

---

PUT /api/company-groups/{resourceId}

Updates a company group (e.g. name). Replace {resourceId} with the group ID.

Updates a company group

put

Required scopes

This endpoint requires the following scopes:

• : API

Authorizations

oauth2bearerAuth

OAuth2clientCredentialsRequired

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

Token URL:

Path parameters

resourceIdstringRequired

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

namestring · min: 1 · max: 64Required

A group name

companyResourceIdArraystring[] · nullableOptional

Array of company resourceIds will be added to the group

Responses

200

OK

application/json

statusstringOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

put

/api/company-groups/{resourceId}

HTTPcURLJavaScriptPython

PUT /api/company-groups/{resourceId} HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 49

{
  "name": "text",
  "companyResourceIdArray": [
    "text"
  ]
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "data": {
    "resourceId": "text"
  },
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

---

PUT /api/company-groups/{resourceId}/participants

Sets the participants (companies) in a company group. Replace {resourceId} with the group ID; request body = array of company resource IDs. Replaces the full member list. Participants = the companies in the group (see Terminology in DOCUMENTATION-RULES).

Adds companies in the given array to a company group

put

Required scopes

This endpoint requires the following scopes:

• : API

Authorizations

oauth2bearerAuth

OAuth2clientCredentialsRequired

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

Token URL:

Path parameters

resourceIdstringRequired

ResourceId of the Company Group which the companies will be added

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

companyResourceIdArraystring[] · nullableOptional

Array of company resourceIds will be added to the group

Responses

200

OK

application/json

statusstringOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

put

/api/company-groups/{resourceId}/participants

HTTPcURLJavaScriptPython

PUT /api/company-groups/{resourceId}/participants HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 35

{
  "companyResourceIdArray": [
    "text"
  ]
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "data": {
    "resourceId": "text"
  },
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

---

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. For search/export use minimal body: pageNumber, pageSize, orderBy, ascending, filter.

Related: Scope API requests to a customer →. List companies with license details →. Create a company → (add new company to a group).

Platform UI: Manage company groups in Company → Company Groups. Company groups →