---
title: "Get Portal Customization Settings"
url: "https://nov18-dev.movespot.fyi/apis/portal-2/versions/891fea74-0458-4c01-8657-e3e36ffacc99/operations/get-portal-customization"
---

> Full API specification: https://nov18-dev.movespot.fyi/apis/portal-2/versions/891fea74-0458-4c01-8657-e3e36ffacc99.md

# Get Portal Customization Settings

`GET` `/api/v3/customization`

Operation ID: `get-portal-customization`

Returns the portal's custom settings.

## Responses

- `200` - Response for custom portal settings

## OpenAPI definition

```yaml
openapi: 3.0.0
info:
  title: Portal
  version: 3.3.1
paths:
  /api/v3/customization:
    get:
      operationId: get-portal-customization
      summary: Get Portal Customization Settings
      description: Returns the portal's custom settings.
      responses:
        "200":
          $ref: "#/components/responses/PortalCustomizationResponse"
      security:
        - {}
      tags:
        - Portal
security:
  - {}
components:
  responses:
    PortalCustomizationResponse:
      description: Response for custom portal settings
      content:
        application/json:
          schema:
            $ref: "#/components/schemas/PortalCustomization"
  schemas:
    PortalCustomization:
      description: The custom settings of this portal
      type: object
      properties:
        theme:
          type: object
          additionalProperties: false
          properties:
            name:
              type: string
              nullable: false
            mode:
              type: string
              enum:
                - light
                - dark
                - system
            colors:
              type: object
              additionalProperties: false
              properties:
                primary:
                  type: string
                  example: "#000000"
                  nullable: false
                  pattern: ^#([a-fA-F0-9]{6}|[a-fA-F0-9]{3})$
                  x-validation-message: must be a valid hex color value
        layout:
          type: string
          nullable: false
        css:
          type: string
          nullable: true
        menu:
          type: object
          additionalProperties: false
          properties:
            main:
              type: array
              items:
                $ref: "#/components/schemas/PortalMenuItem"
            footer_sections:
              type: array
              items:
                $ref: "#/components/schemas/PortalFooterMenuSection"
            footer_bottom:
              type: array
              items:
                $ref: "#/components/schemas/PortalMenuItem"
        spec_renderer:
          type: object
          additionalProperties: false
          properties:
            try_it_ui:
              description: Enable in-browser testing for your APIs. All linked gateways must
                have the CORS plugin configured.
              type: boolean
              default: true
            try_it_insomnia:
              description: Enables users to open API specifications in Insomnia to explore and
                send requests with the native client. Only public API
                specifications are supported.
              type: boolean
              default: true
            infinite_scroll:
              description: Display the full spec on a single, scrollable page. If disabled,
                documentation, endpoints, and schemas appear on separate pages.
              type: boolean
              default: true
            show_schemas:
              description: Control whether schemas are visible in your API specs. When
                enabled, schemas appear in the side navigation below the
                endpoints.
              type: boolean
              default: true
            hide_internal:
              description: Manage visibility of internal endpoints and models.
              type: boolean
              default: false
            hide_deprecated:
              description: Manage visibility of deprecated endpoints and models.
              type: boolean
              default: false
            allow_custom_server_urls:
              description: Let users define a custom server URL for endpoints. This will be
                used to generate code snippets and to test the API. The URL is
                client-side only and is not saved.
              type: boolean
              default: true
        robots:
          type: string
          nullable: true
      additionalProperties: false
      title: PortalCustomization
    PortalMenuItem:
      type: object
      properties:
        path:
          description: The absolute path of a page in a portal with a leading slash.
          type: string
          example: /about/company
          maxLength: 512
        title:
          description: The link display text
          type: string
          example: My Page
        visibility:
          description: Whether a menu item is public or private. Private menu items are
            only accessible to authenticated users.
          type: string
          example: public
          enum:
            - public
            - private
        external:
          description: When clicked, open the link in a new window
          type: boolean
      additionalProperties: false
      required:
        - path
        - title
        - visibility
        - external
    PortalFooterMenuSection:
      type: object
      properties:
        title:
          description: The footer menu section title
          type: string
          maxLength: 512
        items:
          type: array
          items:
            $ref: "#/components/schemas/PortalMenuItem"
      additionalProperties: false
      required:
        - title
        - items
```
