---
title: "Schema describing the screener UI (sections, pages, groups)."
url: "https://developer.argaam.com/apis/search-discovery-layer-api-production-v1/versions/3ee95f1c-cb8f-47a6-bf01-11e0c199d2ad/operations/getScreenerStructure"
---

> Full API specification: https://developer.argaam.com/apis/search-discovery-layer-api-production-v1/versions/3ee95f1c-cb8f-47a6-bf01-11e0c199d2ad.md

# Schema describing the screener UI (sections, pages, groups).

`GET` `/api/v1.1/screener/structure`

Operation ID: `getScreenerStructure`

Returns the **complete screening schema** that powers the Argaam web screener. Use this endpoint as the source of truth for which fields are available, how they are grouped into pages/sections, and the default UI layout. ### Example ``` GET /api/v1.1/screener/structure ``` ### Response shape Hierarchical: `pages -> sections -> field groups -> fields`. Each field carries display labels (Ar/En), data type, units, allowed operators, and grouping metadata.

## Responses

- `200` - Success

## OpenAPI definition

````yaml
openapi: 3.0.1
info:
  title: Search & Discovery Layer API
  version: v1.1
servers:
  - url: https://api.argaam.com
    description: Argaam API Gateway (Production)
paths:
  /api/v1.1/screener/structure:
    get:
      tags:
        - Screener
      responses:
        "200":
          description: Success
      summary: Schema describing the screener UI (sections, pages, groups).
      description: "Returns the **complete screening schema** that powers the\r

        Argaam web screener. Use this endpoint as the source of truth\r

        for which fields are available, how they are grouped into\r

        pages/sections, and the default UI layout.\r

        \            \r

        ### Example\r

        ```\r

        GET /api/v1.1/screener/structure\r

        ```\r

        \            \r

        ### Response shape\r

        Hierarchical: `pages -> sections -> field groups -> fields`.\r

        Each field carries display labels (Ar/En), data type, units,\r

        allowed operators, and grouping metadata."
      operationId: getScreenerStructure
      parameters: []
security:
  - ApiKeyAuth: []
components:
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: apikey
````