Organization

The organization API features an endpoint to retrieve organization data, and an endpoint to retrieve user data. Both use the API key to determine which organization to query.

Organization

GET /api-v2/organization

Returns organization data. The returned data is a javascript object with fullname and name attributes.

Value Description
fullname Full name of the organization
name Organization’s subdomain name

Example output:

{
    "data": {
        "name": "internal",
        "fullname": "AppNeta TraceView"
    },
    "response": "ok"
}

Users

GET /api-v2/organization/users

Returns user data for your organization. Returns a series of javascript objects, one for each user, with name, email, and admin attributes.

Value Description
name The user’s full name.
email The user’s email address.
admin Whether the user is an admin for your organization.

Example output:

{
    "data": [ {
        "name": "John Doe",
        "email": "jdoe@organization.com",
        "admin": false
    }, {
        "name": "Tom Jones",
        "email": "tjones@organization.com",
        "admin": false
    }, {
        "name": "Huck Finn",
        "email": "hfinn@organization.com",
        "admin": true
    }],
    "response": "ok"
}

Licenses

GET /api-v2/organization/licenses

Returns the the number of hosts currently in use, and the number of hosts that are licensed to the organization.

Value Description
hosts_used # of hosts currently in use
hosts_limit # of hosts your organization is limited to
{
    "data": {
        "hosts_used": 2,
        "hosts_limit": 5
    },
    "response":"ok"
}

Table Of Contents

Related Topics