Propstack MCP by usefulapi

Read Propstack contacts, properties, projects, deals, tasks, events; create and update CRM records.

使うべきか

品質と安全性

A
説明の品質
100%
スキーマの完全性
85%
命名の品質
80%
ポイズニングのリスク
100%
権限の一致
100%
プロトコルへの準拠
100%

ツール定義とプロトコルへの準拠に関する自動分析に基づいています。

コンテキストコスト

~6,801トークン数(ツール定義)
~3.4 KB一般的なレスポンスサイズ
注意への影響は大きい(128k コンテキストの 5.31%)

これは、サーバーのツールがモデルのコンテキストに読み込まれるたびに消費されるおおよそのトークン数です。数が多いほど、ほかのタスクに使える注意が減ります。

インストール

ワンクリックインストール

これを `claude_desktop_config.json` ファイルに追加してください:

{
  "mcpServers": {
    "propstack": {
      "url": "https://propstack.usefulapi.io/mcp"
    }
  }
}

リモートエンドポイント

https://propstack.usefulapi.io/mcpstreamable-http

できること

ツール一覧

ツール(18)

🟢 読み取り専用🟡 書き込み🔴 削除⚪ 不明
🟢propstack_list_contacts(query, email, phone_number, status_ids, source_ids, ...)

List or search CRM contacts (Kontakte). Returns business fields only (name, company, email, phone numbers, status, source, tags, owner, dates), never birth data, identity or tax numbers, income or portal tokens. Search by free text (name, email, address, phone), exact email, exact phone number, or filter by status, source, tag, owner and dates. Archived contacts are excluded unless archived is set. GET /contacts.

入力スキーマ

{
  "type": "object",
  "properties": {
    "query": {
      "description": "Free-text search over first name, last name, emails, address and phone numbers.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "email": {
      "description": "Exact email address of the contact.",
      "type": "string",
      "minLength": 1,
      "maxLength": 254
    },
    "phone_number": {
      "description": "Exact phone number (spaces and dashes are ignored).",
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "status_ids": {
      "description": "Only contacts with one of these contact-status ids.",
      "minItems": 1,
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "source_ids": {
      "description": "Only contacts from one of these source ids (see propstack_get_reference_data contact_sources).",
      "minItems": 1,
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "tag_ids": {
      "description": "Only contacts with these tag (Merkmal) ids (see propstack_get_reference_data contact_tags).",
      "minItems": 1,
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "broker_id": {
      "description": "Only contacts looked after by this user id (see propstack_list_users).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "archived": {
      "description": "'only' = only archived contacts, 'include' = archived and active. Default: active only.",
      "type": "string",
      "enum": [
        "only",
        "include"
      ]
    },
    "include_children": {
      "description": "Also return sub-contacts (contact persons of a company).",
      "type": "boolean"
    },
    "sort_by": {
      "description": "Sort field.",
      "type": "string",
      "enum": [
        "last_contact_at",
        "created_at",
        "updated_at",
        "first_name",
        "last_name"
      ]
    },
    "order": {
      "description": "Sort direction.",
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "created_after": {
      "description": "Only contacts created at or after this ISO 8601 date-time.",
      "type": "string"
    },
    "created_before": {
      "description": "Only contacts created at or before this ISO 8601 date-time.",
      "type": "string"
    },
    "updated_after": {
      "description": "Only contacts updated at or after this ISO 8601 date-time.",
      "type": "string"
    },
    "updated_before": {
      "description": "Only contacts updated at or before this ISO 8601 date-time.",
      "type": "string"
    },
    "page": {
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "per": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢propstack_get_contact(contact_id, custom_fields, include)

One contact by id with address, salutation, language, notes, GDPR status, owner, status, source, tags, sub-contacts and owned properties. Birth data, identity and tax numbers, income and the portal token are never returned. GET /contacts/{id}.

入力スキーマ

{
  "type": "object",
  "properties": {
    "contact_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Propstack contact id."
    },
    "custom_fields": {
      "description": "Names of custom fields to return (only these; sensitive ones such as birth date or income are never returned).",
      "minItems": 1,
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100
      }
    },
    "include": {
      "description": "Related records to include: sub-contacts and/or properties the contact owns.",
      "maxItems": 2,
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "children",
          "owned_properties"
        ]
      }
    }
  },
  "required": [
    "contact_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢propstack_list_properties(query, status_ids, tag_ids, project_id, marketing_type, ...)

List or search properties (Objekte / units): address, type, marketing type (buy/rent), rooms, areas, prices, status. Images and owners are not returned. Filter by free text, status, tag, project, marketing type, object type, price and area ranges. GET /units.

入力スキーマ

{
  "type": "object",
  "properties": {
    "query": {
      "description": "Free-text search over unit id, street, zip code, city, district and exposee id.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "status_ids": {
      "description": "Only properties in one of these status ids (see propstack_get_reference_data property_statuses).",
      "minItems": 1,
      "maxItems": 30,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "tag_ids": {
      "description": "Only properties with one of these tag ids (see propstack_get_reference_data property_tags).",
      "minItems": 1,
      "maxItems": 30,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "project_id": {
      "description": "Only the units of this project id.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "marketing_type": {
      "description": "Sale or rent.",
      "type": "string",
      "enum": [
        "BUY",
        "RENT"
      ]
    },
    "rs_type": {
      "description": "Property type.",
      "type": "string",
      "enum": [
        "APARTMENT",
        "HOUSE",
        "TRADE_SITE",
        "GARAGE",
        "SHORT_TERM_ACCOMODATION",
        "OFFICE",
        "GASTRONOMY",
        "INDUSTRY",
        "STORE",
        "SPECIAL_PURPOSE",
        "INVESTMENT"
      ]
    },
    "country": {
      "description": "Two-letter ISO country code, e.g. DE.",
      "type": "string",
      "minLength": 2,
      "maxLength": 2
    },
    "archived": {
      "description": "'only' = only archived properties, 'include' = archived and active. Default: active only.",
      "type": "string",
      "enum": [
        "only",
        "include"
      ]
    },
    "price_from": {
      "description": "Minimum purchase price.",
      "type": "number",
      "minimum": 0
    },
    "price_to": {
      "description": "Maximum purchase price.",
      "type": "number",
      "minimum": 0
    },
    "base_rent_from": {
      "description": "Minimum cold rent.",
      "type": "number",
      "minimum": 0
    },
    "base_rent_to": {
      "description": "Maximum cold rent.",
      "type": "number",
      "minimum": 0
    },
    "living_space_from": {
      "description": "Minimum living space in square metres.",
      "type": "number",
      "minimum": 0
    },
    "living_space_to": {
      "description": "Maximum living space in square metres.",
      "type": "number",
      "minimum": 0
    },
    "rooms_from": {
      "description": "Minimum number of rooms.",
      "type": "number",
      "minimum": 0
    },
    "rooms_to": {
      "description": "Maximum number of rooms.",
      "type": "number",
      "minimum": 0
    },
    "sort_by": {
      "description": "Sort field.",
      "type": "string",
      "enum": [
        "created_at",
        "updated_at",
        "price",
        "base_rent",
        "property_space_value",
        "number_of_rooms",
        "construction_year"
      ]
    },
    "order": {
      "description": "Sort direction.",
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "page": {
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "per": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢propstack_get_property(property_id)

One property (Objekt) by id: address, type, rooms, areas, prices, status and the description, location and furnishing texts (clipped). No images or owner. GET /units/{id}.

入力スキーマ

{
  "type": "object",
  "properties": {
    "property_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Propstack property id."
    }
  },
  "required": [
    "property_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢propstack_list_projects

List projects (Projekte: a project groups several property units): title, project id, status, address, owner. Not paged; at most 200 are returned. GET /projects.

入力スキーマ

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢propstack_list_deals(deal_pipeline_id, deal_stage_ids, category, contact_id, property_id, ...)

List deals (a deal links a contact to a property and sits in a pipeline stage). Filter by pipeline, stage, category (qualified/unqualified/lost), contact, property, project or owner. Use propstack_list_deal_pipelines for stage ids. GET /client_properties.

入力スキーマ

{
  "type": "object",
  "properties": {
    "deal_pipeline_id": {
      "description": "Only deals in this pipeline.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "deal_stage_ids": {
      "description": "Only deals in these stages.",
      "minItems": 1,
      "maxItems": 50,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "category": {
      "description": "Deal category.",
      "type": "string",
      "enum": [
        "qualified",
        "unqualified",
        "lost"
      ]
    },
    "contact_id": {
      "description": "Only the deals of this contact.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "property_id": {
      "description": "Only the deals of this property.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "project_id": {
      "description": "Only the deals of this project.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "broker_id": {
      "description": "Only deals owned by this user id.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "created_after": {
      "description": "Only deals created at or after this ISO 8601 date-time.",
      "type": "string"
    },
    "created_before": {
      "description": "Only deals created at or before this ISO 8601 date-time.",
      "type": "string"
    },
    "include_contact": {
      "description": "Embed a short contact record in each deal (default false).",
      "type": "boolean"
    },
    "include_property": {
      "description": "Embed a short property record in each deal (default false).",
      "type": "boolean"
    },
    "sort_by": {
      "description": "Sort field (default created_at).",
      "type": "string",
      "pattern": "^[a-z_]{1,40}$"
    },
    "order": {
      "description": "Sort direction.",
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "page": {
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "per": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢propstack_list_deal_pipelines

List the deal pipelines with their stages (id, name, position, win chance). Use the stage ids to filter deals or to move a deal. GET /deal_pipelines.

入力スキーマ

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢propstack_list_activities(item_type, contact_id, property_id, project_id, broker_id, ...)

List the activity timeline (notes, tasks, appointments, e-mails, SMS, letters, rejections, inquiries) with title, linked contacts and properties, state and dates. Message and note bodies are not returned. Filter by type, contact, property, project, owner, category or date. GET /activities.

入力スキーマ

{
  "type": "object",
  "properties": {
    "item_type": {
      "description": "Kind of activity; 'reminder' is a to-do.",
      "type": "string",
      "enum": [
        "message",
        "note",
        "reminder",
        "event",
        "policy",
        "cancelation",
        "decision",
        "sms",
        "letter"
      ]
    },
    "contact_id": {
      "description": "Only activities linked to this contact.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "property_id": {
      "description": "Only activities linked to this property.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "project_id": {
      "description": "Only activities linked to this project.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "broker_id": {
      "description": "Only activities assigned to this user id.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "category_id": {
      "description": "Only this activity type id (see propstack_get_reference_data activity_types).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "only_inquiries": {
      "description": "Only inquiries (Anfragen).",
      "type": "boolean"
    },
    "starts_after": {
      "description": "Only activities that start at or after this ISO 8601 date-time.",
      "type": "string"
    },
    "starts_before": {
      "description": "Only activities that start at or before this ISO 8601 date-time.",
      "type": "string"
    },
    "created_after": {
      "description": "Only activities created at or after this ISO 8601 date-time.",
      "type": "string"
    },
    "created_before": {
      "description": "Only activities created at or before this ISO 8601 date-time.",
      "type": "string"
    },
    "order": {
      "description": "Sort direction.",
      "type": "string",
      "enum": [
        "asc",
        "desc"
      ]
    },
    "page": {
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "per": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢propstack_get_task(task_id)

One task by id (a note, to-do or appointment): title, body text (clipped), type, linked contacts, properties and projects (id and name only), due date or start/end. GET /tasks/{id}.

入力スキーマ

{
  "type": "object",
  "properties": {
    "task_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Propstack task id (the id of a note, to-do or appointment)."
    }
  },
  "required": [
    "task_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢propstack_list_events(starts_after, starts_before, broker_id, contact_id, property_id, ...)

List calendar appointments (Termine, e.g. viewings) in a time window, with title, place, start/end, state and the linked contact, property and project (id and name only). Paged: follow next_page. GET /events.

入力スキーマ

{
  "type": "object",
  "properties": {
    "starts_after": {
      "description": "Only events that start after this ISO 8601 date-time.",
      "type": "string"
    },
    "starts_before": {
      "description": "Only events that start before this ISO 8601 date-time.",
      "type": "string"
    },
    "broker_id": {
      "description": "Only events assigned to this user id.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "contact_id": {
      "description": "Only events with this contact.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "property_id": {
      "description": "Only events for this property.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "project_id": {
      "description": "Only events for this project.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "state": {
      "description": "Event state.",
      "type": "string",
      "enum": [
        "neutral",
        "took_place",
        "cancelled"
      ]
    },
    "page": {
      "description": "Page number, from 1 (default 1). Pass the previous reply's next_page.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100000
    },
    "per": {
      "description": "Results per page, 1-100 (default 25).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 100
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢propstack_list_users

List the users (staff, Nutzer) of the Propstack account: id, name, work email, position, phone, team. Use the ids as owner/broker filters. GET /brokers.

入力スキーマ

{
  "type": "object",
  "properties": {},
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🟢propstack_get_reference_data(kind)

Look up the ids used by other tools: property_statuses, activity_types (note/task/appointment types, needed as note_type_id), contact_sources, reservation_reasons (rejection reasons), contact_tags or property_tags. GET /property_statuses, /activity_types, /contact_sources, /reservation_reasons or /groups.

入力スキーマ

{
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "property_statuses",
        "activity_types",
        "contact_sources",
        "reservation_reasons",
        "contact_tags",
        "property_tags"
      ],
      "description": "Which list to fetch."
    }
  },
  "required": [
    "kind"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🔴propstack_create_contact(first_name, last_name, email, salutation, academic_title, ...)

WRITE: create a CRM contact. Propstack matches on the email address: if a contact with the same email already exists it is UPDATED with the given fields instead of creating a duplicate. Consent flags (newsletter, contact permission, GDPR status) cannot be set here. Returns the contact id. POST /contacts.

入力スキーマ

{
  "type": "object",
  "properties": {
    "first_name": {
      "description": "First name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "last_name": {
      "description": "Last name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "email": {
      "description": "Primary email address.",
      "type": "string",
      "maxLength": 254,
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
    },
    "salutation": {
      "description": "Salutation: mr or ms.",
      "type": "string",
      "enum": [
        "mr",
        "ms"
      ]
    },
    "academic_title": {
      "description": "Academic title, e.g. Dr.",
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "company": {
      "description": "Company the contact works for.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "position": {
      "description": "Position in the company.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "is_company": {
      "description": "True if the contact is a company.",
      "type": "boolean"
    },
    "home_cell": {
      "description": "Mobile number.",
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "home_phone": {
      "description": "Landline number.",
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "office_phone": {
      "description": "Business phone number.",
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "office_cell": {
      "description": "Business mobile number.",
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "description": {
      "description": "Internal note on the contact.",
      "type": "string",
      "minLength": 1,
      "maxLength": 5000
    },
    "language": {
      "description": "Contact language.",
      "type": "string",
      "enum": [
        "de",
        "en",
        "es"
      ]
    },
    "client_status_id": {
      "description": "Contact status id.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "client_source_id": {
      "description": "Contact source id (see propstack_get_reference_data contact_sources).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "broker_id": {
      "description": "User id of the person looking after the contact.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "custom_fields": {
      "description": "Custom field values by field name; only the given fields change.",
      "type": "object",
      "propertyNames": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 2000
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          },
          {
            "type": "null"
          }
        ]
      }
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🔴propstack_update_contact(contact_id, first_name, last_name, email, salutation, ...)

WRITE: change the given fields of an existing contact; fields not given stay as they are. Returns the updated contact (business fields). PUT /contacts/{id}.

入力スキーマ

{
  "type": "object",
  "properties": {
    "contact_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Propstack contact id."
    },
    "first_name": {
      "description": "First name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "last_name": {
      "description": "Last name.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "email": {
      "description": "Primary email address.",
      "type": "string",
      "maxLength": 254,
      "format": "email",
      "pattern": "^(?:[A-Za-z0-9_'+\\-]+\\.)*[A-Za-z0-9_'+\\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$"
    },
    "salutation": {
      "description": "Salutation: mr or ms.",
      "type": "string",
      "enum": [
        "mr",
        "ms"
      ]
    },
    "academic_title": {
      "description": "Academic title, e.g. Dr.",
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "company": {
      "description": "Company the contact works for.",
      "type": "string",
      "minLength": 1,
      "maxLength": 200
    },
    "position": {
      "description": "Position in the company.",
      "type": "string",
      "minLength": 1,
      "maxLength": 100
    },
    "is_company": {
      "description": "True if the contact is a company.",
      "type": "boolean"
    },
    "home_cell": {
      "description": "Mobile number.",
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "home_phone": {
      "description": "Landline number.",
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "office_phone": {
      "description": "Business phone number.",
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "office_cell": {
      "description": "Business mobile number.",
      "type": "string",
      "minLength": 1,
      "maxLength": 40
    },
    "description": {
      "description": "Internal note on the contact.",
      "type": "string",
      "minLength": 1,
      "maxLength": 5000
    },
    "language": {
      "description": "Contact language.",
      "type": "string",
      "enum": [
        "de",
        "en",
        "es"
      ]
    },
    "client_status_id": {
      "description": "Contact status id.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "client_source_id": {
      "description": "Contact source id (see propstack_get_reference_data contact_sources).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "broker_id": {
      "description": "User id of the person looking after the contact.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "custom_fields": {
      "description": "Custom field values by field name; only the given fields change.",
      "type": "object",
      "propertyNames": {
        "type": "string",
        "minLength": 1,
        "maxLength": 100
      },
      "additionalProperties": {
        "anyOf": [
          {
            "type": "string",
            "maxLength": 2000
          },
          {
            "type": "number"
          },
          {
            "type": "boolean"
          },
          {
            "type": "null"
          }
        ]
      }
    }
  },
  "required": [
    "contact_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🔴propstack_create_task(kind, title, note_type_id, body, contact_ids, ...)

WRITE: create a note, a to-do (with due date) or an appointment (with start and end) in Propstack, linked to contacts, properties or projects. note_type_id is the activity type id (see propstack_get_reference_data activity_types). No e-mail or SMS is sent to the contact; the only mail is the reminder to the assignee when remind_at is set. Returns the new task id. POST /tasks.

入力スキーマ

{
  "type": "object",
  "properties": {
    "kind": {
      "type": "string",
      "enum": [
        "note",
        "todo",
        "appointment"
      ],
      "description": "note = plain note, todo = task with due_date, appointment = event with starts_at and ends_at."
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 250,
      "description": "Title."
    },
    "note_type_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Activity type id; must match the kind (see propstack_get_reference_data activity_types)."
    },
    "body": {
      "description": "Note text (plain text; stored as escaped HTML with line breaks).",
      "type": "string",
      "minLength": 1,
      "maxLength": 20000
    },
    "contact_ids": {
      "description": "Contacts the activity is linked to (usually one).",
      "minItems": 1,
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "property_ids": {
      "description": "Properties the activity is linked to.",
      "minItems": 1,
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "project_ids": {
      "description": "Projects the activity is linked to.",
      "minItems": 1,
      "maxItems": 20,
      "type": "array",
      "items": {
        "type": "integer",
        "exclusiveMinimum": 0,
        "maximum": 9007199254740991
      }
    },
    "broker_id": {
      "description": "User id the task is assigned to.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "due_date": {
      "description": "Due date and time (todo only).",
      "type": "string"
    },
    "remind_at": {
      "description": "When Propstack e-mails a reminder to the assignee, before due_date (todo only). This sends a mail to a colleague.",
      "type": "string"
    },
    "starts_at": {
      "description": "Start (appointment only).",
      "type": "string"
    },
    "ends_at": {
      "description": "End (appointment only).",
      "type": "string"
    },
    "location": {
      "description": "Place (appointment only).",
      "type": "string",
      "minLength": 1,
      "maxLength": 300
    }
  },
  "required": [
    "kind",
    "title",
    "note_type_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🔴propstack_update_task(task_id, title, body, broker_id, done, ...)

WRITE: change the given fields of an existing note, to-do or appointment (for example mark a to-do done, move its due date, or reschedule). Fields not given stay as they are. PUT /tasks/{id}.

入力スキーマ

{
  "type": "object",
  "properties": {
    "task_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Propstack task id."
    },
    "title": {
      "description": "Title.",
      "type": "string",
      "minLength": 1,
      "maxLength": 250
    },
    "body": {
      "description": "Note text (plain text; stored as escaped HTML with line breaks).",
      "type": "string",
      "minLength": 1,
      "maxLength": 20000
    },
    "broker_id": {
      "description": "User id the task is assigned to.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "done": {
      "description": "Mark a to-do done (true) or open (false).",
      "type": "boolean"
    },
    "due_date": {
      "description": "New due date and time (to-do).",
      "type": "string"
    },
    "remind_at": {
      "description": "New reminder time (to-do).",
      "type": "string"
    },
    "starts_at": {
      "description": "New start (appointment).",
      "type": "string"
    },
    "ends_at": {
      "description": "New end (appointment).",
      "type": "string"
    },
    "location": {
      "description": "New place (appointment).",
      "type": "string",
      "minLength": 1,
      "maxLength": 300
    }
  },
  "required": [
    "task_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🔴propstack_create_deal(contact_id, property_id, deal_stage_id, broker_id, price, ...)

WRITE: create a deal linking a contact to a property in a pipeline stage (see propstack_list_deal_pipelines for stage ids). Returns the new deal. POST /client_properties.

入力スキーマ

{
  "type": "object",
  "properties": {
    "contact_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Contact (prospect) id."
    },
    "property_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Property id."
    },
    "deal_stage_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Pipeline stage id."
    },
    "broker_id": {
      "description": "User id of the deal owner.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "price": {
      "description": "Expected price of the deal.",
      "type": "number",
      "minimum": 0
    },
    "note": {
      "description": "Internal note on the deal.",
      "type": "string",
      "minLength": 1,
      "maxLength": 5000
    }
  },
  "required": [
    "contact_id",
    "property_id",
    "deal_stage_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}
🔴propstack_update_deal(deal_id, deal_stage_id, broker_id, price, note)

WRITE: change the given fields of a deal, typically move it to another pipeline stage or update its note or price. Fields not given stay as they are. PUT /client_properties/{id}.

入力スキーマ

{
  "type": "object",
  "properties": {
    "deal_id": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991,
      "description": "Propstack deal id."
    },
    "deal_stage_id": {
      "description": "Move the deal to this stage.",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "broker_id": {
      "description": "New deal owner (user id).",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "price": {
      "description": "Expected price of the deal.",
      "type": "number",
      "minimum": 0
    },
    "note": {
      "description": "Internal note on the deal (replaces the previous note).",
      "type": "string",
      "minLength": 1,
      "maxLength": 5000
    }
  },
  "required": [
    "deal_id"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

コミュニティ

このサーバーを評価する

エビデンス

最近の観測

検証済みバージョンは記録されていませんツール 18 件