Actor
Reseller

Get Actor

Shows details of the entities associated with the supplied API credentials. It will only return the fields relevant to the current credentials.

Each of reseller, account, and user is returned only when the supplied credentials are associated with that entity, so do not rely on any particular key being present.

When the credentials are associated with an entity but are not permitted to read it, the key is still returned with every field replaced by <REDACTED> — for example, credentials belonging to a user who is a member of an organization but not of its parent account will receive a redacted account.

For more information on User management, see Product Support

get/v1/actor

Request

  • Base URL
    https://api.huntress.io
  • URL
    https://api.huntress.io/v1/actor
  • Auth
    basic (a scheme the document does not define)

Response

Get Actor

resellerunknown
accountunknown
userunknown

Example response

{
  "reseller": {
    "id": 12345,
    "name": "ResellerCo"
  },
  "account": {
    "id": 12345,
    "name": "Huntress"
  },
  "user": {
    "id": 12345,
    "email": "email@example.com",
    "name": "Your User"
  }
}

Changes

No recorded changes to this operation across all 8 revisions of this API.