Heimster Contacts API

The Contacts API from Heimster — 3 operation(s) for contacts.

GitHub OpenAPI

Operations 6

GET /api/v1/contacts List contacts #
POST /api/v1/contacts POST /api/v1/contacts #
GET /api/v1/contacts/{id} Get a contact #
PATCH /api/v1/contacts/{id} Update a contact #
GET /api/v1/contacts/{id}/activities List a contact's activities #
POST /api/v1/contacts/{id}/activities Add a note / activity #

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

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

OpenAPI Specification

heimster-ch-contacts-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Heimster Contacts 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: Contacts
paths:
  /api/v1/contacts:
    get:
      operationId: get_api_v1_contacts
      tags:
      - Contacts
      summary: List contacts
      x-source: https://heimster.ch/developers
      parameters:
      - name: q
        in: query
        required: false
        schema:
          type: string
        description: Query. Search name / email / company.
      - name: phone
        in: query
        required: false
        schema:
          type: string
        description: Match the phone number in any format.
      - 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/GetApiV1ContactsResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v1_contacts
      tags:
      - Contacts
      summary: POST /api/v1/contacts
      x-source: https://heimster.ch/developers
      responses:
        '201':
          description: Success (shape read from the example response on the page)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1ContactsResponse'
      x-evidence:
        kind: code-example
        language: curl
        snippet: "curl JavaScript curl https://heimster.ch/api/v1/contacts  -H \"Authorization: Bearer hm_…\" q phone limit cursor Senden Key oben einfügen zum Ausprobieren Response Beispiel {\n \"data\": [\n {\n \"id\": \"21321f20-…\" ,\n \"name\": \"Lukas Test\" ,\n \"firstName\": \"Lukas\" ,\n \"lastName\": \"Test\" ,\n \"email\": \"demo@demo.com\" ,\n \"phone\": null ,\n \"company\": null ,\n \"role\": \"Käufer\" ,\n \"city\": \"Zürich\" ,\n \"canton\": null ,"
  /api/v1/contacts/{id}:
    get:
      operationId: get_api_v1_contacts_id
      tags:
      - Contacts
      summary: Get a contact
      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/GetApiV1ContactsIdResponse'
      x-evidence:
        kind: documentation
    patch:
      operationId: patch_api_v1_contacts_id
      tags:
      - Contacts
      summary: Update a contact
      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/PatchApiV1ContactsIdRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PatchApiV1ContactsIdResponse'
      x-evidence:
        kind: documentation
  /api/v1/contacts/{id}/activities:
    get:
      operationId: get_api_v1_contacts_id_activities
      tags:
      - Contacts
      summary: List a contact's activities
      x-source: https://heimster.ch/developers
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      - 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/GetApiV1ContactsIdActivitiesResponse'
      x-evidence:
        kind: documentation
    post:
      operationId: post_api_v1_contacts_id_activities
      tags:
      - Contacts
      summary: Add a note / activity
      x-source: https://heimster.ch/developers
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostApiV1ContactsIdActivitiesRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostApiV1ContactsIdActivitiesResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostApiV1ContactsIdActivitiesRequest:
      type: object
      properties:
        title:
          type: string
          description: Short title.
        body:
          type: string
          description: The note itself.
        activityType:
          type: string
          description: One of note, task, meeting, phone_outgoing, phone_incoming, email (default note).
        objectId:
          type: string
          description: Property the note is about.
        viewingId:
          type: string
          description: Viewing the note is about.
        listingId:
          type: string
          description: Listing the note is about.
        projectId:
          type: string
          description: New-build project the note is about.
        anlageobjektId:
          type: string
          description: Investment property the note is about.
      required:
      - title
    PostApiV1ContactsIdActivitiesResponse:
      type: object
      properties:
        data:
          type: object
          description: Created activity.
    GetApiV1ContactsIdResponse:
      type: object
      properties:
        data:
          type: object
          description: Contact details.
    GetApiV1ContactsResponse:
      type: object
      properties:
        data:
          type: array
          description: List of contacts.
        nextCursor:
          type: string
          description: Cursor for pagination.
    PatchApiV1ContactsIdRequest:
      type: object
      properties:
        email:
          type: string
          description: Primary email — the dedupe key within your org.
        firstName:
          type: string
        lastName:
          type: string
        phone:
          type: string
        company:
          type: string
        role:
          type: string
        website:
          type: string
        city:
          type: string
        canton:
          type: string
        postalCode:
          type: string
        country:
          type: string
          description: ISO country code (default CH).
        tags:
          type: array
        internalNotes:
          type: string
    GetApiV1ContactsIdActivitiesResponse:
      type: object
      properties:
        data:
          type: array
          description: Activities list.
        nextCursor:
          type: string
          description: Cursor for pagination.
    PostApiV1ContactsResponse:
      type: object
      properties:
        data:
          type: array
          items:
            type: object
            properties:
              id:
                type: string
              name:
                type: string
              firstName:
                type: string
              lastName:
                type: string
              email:
                type: string
              phone:
                type:
                - string
                - 'null'
              company:
                type:
                - string
                - 'null'
              role:
                type: string
              city:
                type: string
              canton:
                type:
                - string
                - 'null'
              postalCode:
                type:
                - string
                - 'null'
              country:
                type: string
              status:
                type: string
              source:
                type: string
              tags:
                type: array
                items: {}
              summary:
                type: string
              createdAt:
                type: string
                format: date-time
              updatedAt:
                type: string
                format: date-time
        nextCursor:
          type: string
    PatchApiV1ContactsIdResponse:
      type: object
      properties:
        data:
          type: object
          description: Updated contact.
  securitySchemes:
    bearer:
      type: http
      scheme: bearer