˄˅

Companies

Call description

This request returns a list of companies that meet specified search parameters.

You can search for a company using a keyword in one or more columns, e.g.:

{ "search": {"keyword": [Column_number_X, Column_number_Y]}, "skip": 0, "take": 50 }

You can search for more keywords in different columns, e.g.:

{ "search": {"keyword": [Column_number_X, Column_number_Y], "keyword2": [Column_number_Z]}, "skip": 0, "take": 50 }.

Each column is identified by a number. In the type column you can search for parts of a keyword.

•This API call requires authorization; the user has to be logged in.

•Request URL: https://mspapi.eset.com/api/Search/Companies

•This request is a POST call type.

Call structure

{

"search": {

"additionalProp1": [

"additionalProp2": [

"additionalProp3": [

]

"skip": 0,

"take": 0

}

Call parameters

Parameter	Description
additionalProp1	The additionalProp lets you search for a keyword string in specified columns. Type in one or more columns to search in. See the columns descriptions in the table below.
skip, take	If the requested data set is too large, you can split the response into smaller chunks. It works similarly to the paging function. The skip parameter indicates how many entries should be skipped and the take parameter indicates how many entries should be listed. The take value must be from 1 to 100. For example: •to list the first 20 entries, set up: "skip": 0, "take": 20 •to list the second 20 entries (from 21 to 40), set up: "skip": 20, "take": 20

Parameter

Description

additionalProp1

The additionalProp lets you search for a keyword string in specified columns. Type in one or more columns to search in. See the columns descriptions in the table below.

skip, take

If the requested data set is too large, you can split the response into smaller chunks. It works similarly to the paging function. The skip parameter indicates how many entries should be skipped and the take parameter indicates how many entries should be listed. The take value must be from 1 to 100.

For example:

•to list the first 20 entries, set up: "skip": 0, "take": 20

•to list the second 20 entries (from 21 to 40), set up: "skip": 20, "take": 20

List of columns

Search by	Column number	Type	Keyword example	Description
Name	0	String	"MspTest", “Test”
CompanyID	1	Unique identifier	“B8D40DEC-7773-45D2-A2B2-86642A7E5852”
Created on	2	Date	"2016-01-17"
Modified on	3	Date	"2016-02-16"
Custom Identifier	5	String	“789”
Company Type Id	6	Number	"2”	•HQ=0, •Distributor=1, •MSP Manager=2, •MSP=3, •Managed MSP=4, •Managed By MSP=5
Company Status Id	7	Number	“1”	•Active=1, •Suspended=5, •Waiting For Confirmation=6
Comment	8	String	“comment”
VAT Id	9	String	“vat_id”
Description	10	String	“demo”
Email	11	String	“tst@tst.com”

Response structure

The response contains data in the JSON format.

The response contains results count and basic details for each matching company.

Troubleshooting

ESET MSP Administrator 2 API uses standardized error codes. If you are getting errors or unexpected responses, see the Troubleshooting API for common problems and the list of error codes.

List of error codes

˄˅