Heimster

Heimster Objects API

The Objects API from Heimster — 3 operation(s) for objects.

GitHub OpenAPI

Operations 5

GET /api/v1/objects List objects #
POST /api/v1/objects Create an object #
GET /api/v1/objects/{id} Get an object #
PATCH /api/v1/objects/{id} Edit an object #
GET /api/v1/objects/{id}/interested-parties Ranked buyers for an object #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/heimster-ch/openapi/heimster-ch-objects-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/heimster-ch/json-schema/heimster-ch-post-api-v1-telephony-calls-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/heimster-ch/json-schema/heimster-ch-post-api-v1-objects-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/heimster-ch/json-schema/heimster-ch-post-api-v1-contacts-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/heimster-ch/json-schema/heimster-ch-post-api-v1-contacts-id-activities-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/heimster-ch/json-schema/heimster-ch-post-api-v1-viewings-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/heimster-ch/json-schema/heimster-ch-patch-api-v1-contacts-id-request-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/heimster-ch:heimster-ch-objects-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

heimster-ch-objects-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Heimster Objects API
  version: '2026-11-11'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-11: 38 operation(s) read from 1 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Heimster has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 1
    documentation: 37
    pages-with-code: 1
    pages-read: 1
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-11'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://heimster.ch/developers
security:
- bearer: []
tags:
- name: Objects
paths:
  /api/v1/objects:
    get:
      operationId: get_api_v1_objects
      tags:
      - Objects
      summary: List objects
      x-source: https://heimster.ch/developers
      parameters:
      - name: status
        in: query
        required: false
        schema:
          type: string
        description: Filter by status.
      - name: q
        in: query
        required: false
        schema:
          type: string
        description: Search address (street/city/postal) + internal reference.
      - name: limit
        in: query
        required: false
        schema:
          type: integer
        description: Page size, max 100 (default 50).
      - name: cursor
        in: query
        required: false
        schema:
          type: string
        description: The previous response's `nextCursor`.
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1ObjectsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v1_objects
      tags:
      - Objects
      summary: Create an object
      x-source: https://heimster.ch/developers
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1ObjectsRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1ObjectsResponse'
      x-evidence:
        kind: documentation
  /api/v1/objects/{id}:
    get:
      operationId: get_api_v1_objects_id
      tags:
      - Objects
      summary: Get an object
      x-source: https://heimster.ch/developers
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1ObjectsIdResponse'
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_api_v1_objects_id
      tags:
      - Objects
      summary: Edit an object
      x-source: https://heimster.ch/developers
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchApiV1ObjectsIdRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchApiV1ObjectsIdResponse'
      x-evidence:
        kind: documentation
  /api/v1/objects/{id}/interested-parties:
    get:
      operationId: get_api_v1_objects_id_interested_parties
      tags:
      - Objects
      summary: Ranked buyers for an object
      x-source: https://heimster.ch/developers
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetApiV1ObjectsIdInterestedPartiesResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PatchApiV1ObjectsIdRequest:
      type: object
      properties:
        status:
          type: string
        price:
          type: integer
        rooms:
          type: number
        livingSpaceSqm:
          type: number
        yearBuilt:
          type: integer
        notes:
          type: string
        description:
          type: string
    GetApiV1ObjectsIdInterestedPartiesResponse:
      type: object
      properties:
        data:
          type: array
          description: Interested parties list.
        nextCursor:
          type: string
          description: Cursor for pagination (may be null).
    PatchApiV1ObjectsIdResponse:
      type: object
      properties:
        data:
          type: object
          description: Updated object.
    GetApiV1ObjectsIdResponse:
      type: object
      properties:
        data:
          type: object
          description: Object details.
    GetApiV1ObjectsResponse:
      type: object
      properties:
        data:
          type: array
          description: Objects list.
        nextCursor:
          type: string
          description: Cursor for pagination.
    PostApiV1ObjectsResponse:
      type: object
      properties:
        data:
          type: object
          description: Created object.
    PostApiV1ObjectsRequest:
      type: object
      properties:
        propertyType:
          type: string
          description: apartment, house, commercial, parking, land or room.
        intendedUse:
          type: string
          description: rent or sale.
        street:
          type: string
          description: Street and number.
        postalCode:
          type: string
          description: Postal code.
        city:
          type: string
          description: City.
        canton:
          type: string
          description: Canton code, e.g. ZH.
        rooms:
          type: number
          description: Rooms, e.g. 4.5.
        livingSpaceSqm:
          type: number
          description: Living area in m².
        price:
          type: integer
          description: CHF; sale price or monthly rent.
        yearBuilt:
          type: integer
        floorNumber:
          type: integer
          description: Floor (0 = ground floor).
        plotSqm:
          type: number
          description: Plot area in m².
        title:
          type: string
          description: Marketing title.
        description:
          type: string
          description: Marketing description.
        notes:
          type: string
          description: Internal notes.
        internalReference:
          type: string
          description: Your own reference number.
      required:
      - propertyType
      - intendedUse
      - street
      - postalCode
      - city
  securitySchemes:
    bearer:
      type: http
      scheme: bearer