List recently created companies

As a Reseller you list or count companies created in a recent period for billing, onboarding reports, or growth metrics. Use a credential with Client Role = Reseller. Call company search with orderBy: "CreateTime" and ascending: false to get newest first; use filter with a date range on creation date if the API supports it. Total count is in the response or sum across pages.


POST /api/companies/search

Returns a paginated list of companies. Set orderBy: "CreateTime" and ascending: false to list newest companies first. Optionally use filter to restrict by creation date range (see Endpoints → Company for supported filter fields). The response total count gives the number of companies matching the criteria; paginate through all pages if you need a full list or count for a period.

Retrieves a list of all companies. Use orderBy CreateTime and ascending false to list recently created companies first; use filter for a date range if supported.

Retrieves a list of all companies

post
chevron-right
lockRequired 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
chevron-right
200

OK

application/json
statusstringOptional
messagestring · nullableOptional
validationMessagesstring[] · nullableOptional
post
/api/companies/search
200

OK


POST /api/companies/search/export

Exports the company list to CSV or Excel with the same order and filter. Use this to get all recently created companies in one file and compute counts or dates client-side.

Exports the list of companies to CSV or Excel. Use the same orderBy and filter as in search to export recently created companies.

Exports the list of companies

post
chevron-right
lockRequired 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
chevron-right
200

OK

No content

post
/api/companies/search/export
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: "CreateTime", ascending: false; use filter: null or a valid filter structure.

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

Last updated