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

# List designs

> The agency's house designs.



## OpenAPI

````yaml /api-reference/management-openapi.yaml get /{agency_uid}/designs
openapi: 3.0.3
info:
  title: Kenekt Management API
  version: v1
  description: >-
    Manage an agency's stock and team: projects, lots, packages, designs,
    facades, developments, inclusions, commission rates, members and groups.


    Authenticate with an API key from a staff or admin member's account page,
    sent as `Authorization: Bearer YOUR_API_KEY`. A key works on every agency
    where its holder has a staff role; put that agency's public id in the path.


    This API is evolving: endpoints and fields may change without notice.
servers:
  - url: https://app.kenekt.com.au/v1
security: []
tags:
  - name: Stock / Projects
    description: 'Projects: a stage or release inside a development, grouping the lots.'
  - name: Stock / Lots
    description: Lots, their status, and moves between projects.
  - name: Stock / Packages
    description: 'Property packages: the sellable pairing of a lot with a design and facade.'
  - name: Stock / Designs
    description: Designs, their price tiers, rooms, and linked facades.
  - name: Stock / Facades
    description: Facades offered against designs.
  - name: Stock / Developments
    description: 'Developments: the estate or masterplanned community projects sit inside.'
  - name: Stock / Inclusions
    description: Inclusion packages, their items, and what they are linked to.
  - name: Stock / Commission Rates
    description: Commission rates and what they are applied to.
  - name: Stock / Attachments
    description: Photos and documents on any stock resource.
  - name: Stock / Library
    description: >-
      The whole library (designs, price tiers, facades, inclusions) as flat
      export rows.
  - name: Team / Members
    description: Members of the agency, their API keys, documents, and inclusions.
  - name: Team / Groups
    description: User groups and their memberships.
  - name: Team / Engagement
    description: >-
      Agent engagement: who is active, who has gone quiet, what they view and
      search for.
  - name: Agency
    description: The agency record and its settings.
  - name: Agency / Documents
    description: Agency-level documents.
  - name: EOIs
    description: Expressions of interest, purchasers, and sighted ID capture.
paths:
  /{agency_uid}/designs:
    get:
      tags:
        - Stock / Designs
      summary: List designs
      description: The agency's house designs.
      parameters:
        - name: agency_uid
          in: path
          required: true
          schema:
            type: string
          description: Agency public_uid
      responses:
        '200':
          description: OK
          headers:
            Content-Type:
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  designs:
                    type: array
                    items:
                      type: object
                      properties:
                        public_uid:
                          type: string
                        name:
                          type: string
                        description:
                          type: string
                        active:
                          type: boolean
                        bedroom:
                          type: string
                        bathroom:
                          type: string
                        garage:
                          type: string
                        living:
                          nullable: true
                        floor_area:
                          type: string
                        external_area:
                          nullable: true
                        has_study:
                          nullable: true
                        storey_type:
                          type: string
                        building_type:
                          type: string
                        range_name:
                          nullable: true
                        photos_count:
                          type: integer
                        documents_count:
                          type: integer
                        build_width:
                          type: string
                          nullable: true
                        build_length:
                          type: string
                          nullable: true
                        min_width_land:
                          type: string
                        min_length_land:
                          type: string
                        squares:
                          type: string
                        floor_area_second_dwelling:
                          type: string
                        squares_second_dwelling:
                          nullable: true
                        videos:
                          type: array
                          items: {}
                        rooms:
                          type: array
                          items: {}
                      required:
                        - public_uid
                        - name
                        - description
                        - active
                        - bedroom
                        - bathroom
                        - garage
                        - living
                        - floor_area
                        - external_area
                        - has_study
                        - storey_type
                        - building_type
                        - range_name
                        - photos_count
                        - documents_count
                        - build_width
                        - build_length
                        - min_width_land
                        - min_length_land
                        - squares
                        - floor_area_second_dwelling
                        - squares_second_dwelling
                        - videos
                        - rooms
                required:
                  - designs
              example:
                designs:
                  - public_uid: BD-4567
                    name: Design name 2
                    description: ''
                    active: true
                    bedroom: '4'
                    bathroom: '2'
                    garage: '2'
                    living: null
                    floor_area: '0.0'
                    external_area: null
                    has_study: null
                    storey_type: Single Storey
                    building_type: House
                    range_name: null
                    photos_count: 0
                    documents_count: 0
                    build_width: null
                    build_length: null
                    min_width_land: '0.0'
                    min_length_land: '0.0'
                    squares: '0.0'
                    floor_area_second_dwelling: '0.0'
                    squares_second_dwelling: null
                    videos: []
                    rooms: []
                  - public_uid: BD-1234
                    name: KENEKT DESIGN
                    description: |
                      <div class="lexxy-content prose prose-lg max-w-none"
                           data-controller="lexxy-attachments"
                           data-lexxy-attachments-max-bytes-value="5242880"
                           data-lexxy-attachments-types-value="[&quot;image/jpeg&quot;,&quot;image/png&quot;,&quot;application/pdf&quot;]">
                        <div>build design test</div>
                      </div>
                    active: true
                    bedroom: '3'
                    bathroom: '2'
                    garage: '1'
                    living: null
                    floor_area: '150.0'
                    external_area: null
                    has_study: null
                    storey_type: Single Storey
                    building_type: House
                    range_name: null
                    photos_count: 0
                    documents_count: 0
                    build_width: '15'
                    build_length: '12'
                    min_width_land: '12.0'
                    min_length_land: '20.0'
                    squares: '0.0'
                    floor_area_second_dwelling: '0.0'
                    squares_second_dwelling: null
                    videos: []
                    rooms: []
        '401':
          description: Unauthorized
          headers:
            Content-Type:
              schema:
                type: string
      security:
        - bearer_auth: []
components:
  securitySchemes:
    bearer_auth:
      type: http
      scheme: bearer
      bearerFormat: Token

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.