Sign in

v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB
Actors

Get Actor Hierarchy for Current User

Retrieves the actor hierarchy for the current user. Optionally, you can specify an ActorID to get the hierarchy for a specific actor, filter by StatusID, or limit the hierarchy levels returned.

get/v1/actors/hierarchy

Query parameters

ActorIDinteger

Specify the unique identifier of an actor to retrieve its hierarchy instead of the current user's hierarchy.

StatusIDinteger

Filter the hierarchy to only include actors with a specific status identifier.

HierarchyLevelLimitinteger

The maximum number of hierarchy levels to retrieve.

Response

The actor hierarchy was retrieved successfully.

ParentActorIDinteger nullable

The unique identifier of the parent actor, if applicable. This indicates the actor's position within a larger hierarchy.

ActorIDinteger

The unique identifier of the actor.

ActorDescriptionstring nullable

A brief description of the actor.

ActorTypeIDinteger

The identifier representing the type of actor, defining their role or classification.

ActorStatusinteger

The status identifier of the actor, indicating their current status.

ActorHierarchyLevelinteger

The level of hierarchy at which the actor is positioned within the organizational structure.