> ## Documentation Index
> Fetch the complete documentation index at: https://devzone.nayax.com/llms.txt
> Use this file to discover all available pages before exploring further.

# 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.



## OpenAPI

````yaml /openapi/lynx.yaml get /v1/actors/hierarchy
openapi: 3.0.1
info:
  title: Nayax Operational Lynx API
  version: v1
servers:
  - url: https://qa-lynx.nayax.com/operational
security:
  - Authorization: []
paths:
  /v1/actors/hierarchy:
    get:
      tags:
        - Actors
      summary: Get Actor Hierarchy for Current User
      description: >-
        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.
      operationId: get-actor-hierarchy
      parameters:
        - name: ActorID
          in: query
          description: >-
            Specify the unique identifier of an actor to retrieve its hierarchy
            instead of the current user's hierarchy.
          schema:
            type: integer
            format: int64
        - name: StatusID
          in: query
          description: >-
            Filter the hierarchy to only include actors with a specific status
            identifier.
          schema:
            type: integer
            format: int32
        - name: HierarchyLevelLimit
          in: query
          description: The maximum number of hierarchy levels to retrieve.
          schema:
            type: integer
            format: int32
      responses:
        '200':
          description: The actor hierarchy was retrieved successfully.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ActorHirarchyDto'
components:
  schemas:
    ActorHirarchyDto:
      type: object
      description: >-
        Represents the hierarchy of an actor, including details about the actor
        and its children in the hierarchy.
      properties:
        ParentActorID:
          type: integer
          format: int64
          nullable: true
          description: >-
            The unique identifier of the parent actor, if applicable. This
            indicates the actor's position within a larger hierarchy.
        ActorID:
          type: integer
          format: int64
          description: The unique identifier of the actor.
        ActorDescription:
          type: string
          nullable: true
          description: A brief description of the actor.
        ActorTypeID:
          type: integer
          format: int32
          description: >-
            The identifier representing the type of actor, defining their role
            or classification.
        ActorStatus:
          type: integer
          format: int32
          description: The status identifier of the actor, indicating their current status.
        ActorHierarchyLevel:
          type: integer
          format: int32
          description: >-
            The level of hierarchy at which the actor is positioned within the
            organizational structure.
        ActorChildren:
          type: array
          items:
            $ref: '#/components/schemas/ActorHirarchyDto'
          nullable: true
          description: >-
            A list of child actors that belong to this actor, representing the
            next level in the hierarchy.
      additionalProperties: false
  securitySchemes:
    Authorization:
      type: http
      scheme: bearer
      description: Enter your Bearer token. It's required to authenticate API requests.

````