Skip to main content
GET
/
v1
/
actors
/
hierarchy
Get Actor Hierarchy for Current User
curl --request GET \
  --url https://qa-lynx.nayax.com/operational/v1/actors/hierarchy \
  --header 'Authorization: <api-key>'
{
  "ParentActorID": 123,
  "ActorID": 123,
  "ActorDescription": "<string>",
  "ActorTypeID": 123,
  "ActorStatus": 123,
  "ActorHierarchyLevel": 123,
  "ActorChildren": "<array>"
}

Authorizations

Authorization
string
header
required

Enter your API key. It's required to authenticate API requests.

Query Parameters

ActorID
integer<int64>

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

StatusID
integer<int32>

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

HierarchyLevelLimit
integer<int32>

The maximum number of hierarchy levels to retrieve.

Response

200 - application/json

The actor hierarchy was retrieved successfully.

Represents the hierarchy of an actor, including details about the actor and its children in the hierarchy.

ParentActorID
integer<int64> | null

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

ActorID
integer<int64>

The unique identifier of the actor.

ActorDescription
string | null

A brief description of the actor.

ActorTypeID
integer<int32>

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

ActorStatus
integer<int32>

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

ActorHierarchyLevel
integer<int32>

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

ActorChildren
array | null

A list of child actors that belong to this actor, representing the next level in the hierarchy.