Descendants
Call description
This call returns a list of all child objects of the specified type for the specified company.
•This API call requires authorization; the user has to be logged in.
•Request URL: https://mspapi.eset.com/api/Company/Descendants
•This request is a POST call type.
Call structure
{
"companyId": "string",
"entityType": "Any",
"skip": 0,
"take": 0
}
Call parameters
Parameter |
Description |
|---|---|
companyId |
companyId is a unique identifier of a company. To get the companyId of the logged in user, use /api/User/Current call. |
entityType |
The entityType, or type is a numeric code representing the entity, e.g. Distributor or a MSP. You can get a list of available entity types with the EntityTypes call. |
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 |
Response structure
The response contains data in the JSON format.
The return values contain main data fields:
•name - Company name
•publicId - The publicId parameter is the companyId of the company listed in the selection.
•type
•email - contact email address
•status
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.