Manage Teamgate CRM leads, people, companies, deals, activities and notes.
Maintain this server? Claim it
Call this server's tools from your browser. Nothing to install.
Requests go through mcptry because browsers can't call most MCP servers directly. Header values are sent to the server for that request only and are never stored or logged.
Tool list from our last check. Connect live to refresh it.
WRITE: add a note to one or more leads, companies or deals. The note cannot be edited or removed with these tools. POST /events.
The note text.
Deals to link.
Leads to link.
Companies to link.
The server marks this tool as destructive. Running it may delete or overwrite data on the server or in any account you connected with your headers.
WRITE: add a note to one or more leads, companies or deals. The note cannot be edited or removed with these tools. POST /events.
| Argument | Type | Description |
|---|---|---|
| text* | string | The note text. |
| deal_ids | array | Deals to link. |
| lead_ids | array | Leads to link. |
| company_ids | array | Companies to link. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"maxLength": 10000,
"minLength": 1,
"description": "The note text."
},
"deal_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 20,
"minItems": 1,
"description": "Deals to link."
},
"lead_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 20,
"minItems": 1,
"description": "Leads to link."
},
"company_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 20,
"minItems": 1,
"description": "Companies to link."
}
}
}WRITE: create a task, call or appointment, optionally linked to leads, companies or deals. Teamgate may send reminders to the owner. POST /events.
| Argument | Type | Description |
|---|---|---|
| end | string | End (RFC 3339 date-time with timezone). |
| name* | string | Activity title. |
| type* | string | Kind of activity. |
| start | string | Start (RFC 3339 date-time with timezone). |
| deal_ids | array | Deals to link. |
| lead_ids | array | Leads to link. |
| owner_id | integer | Owner user id (see teamgate_list_users). |
| company_ids | array | Companies to link. |
| description | string | Details. |
WRITE: create a company. POST /companies.
| Argument | Type | Description |
|---|---|---|
| name* | string | Company name. |
| tags | array | Tags to set on the record. |
| string | Email address. | |
| phone | string | Phone number. |
| source | string | Source name (created if it does not exist). |
| starred | boolean | Star the record. |
| industry | string | Industry name (created if it does not exist). |
| owner_id | integer | Owner user id (see teamgate_list_users). |
| vat_code | string | VAT identification number. |
| customer_status | integer | 0 = non customer, 1 = past customer, 2 = customer. |
WRITE: create a deal for a buyer (a person or company). POST /deals.
| Argument | Type | Description |
|---|---|---|
| name* | string | Deal name. |
| tags | array | Tags to set on the record. |
| source | string | Source name (created if it does not exist). |
| status | string | Deal status. |
| starred | boolean | Star the record. |
| buyer_id* | integer | Id of the person or company that buys, as returned by the list tools. |
| owner_id | integer | Owner user id (see teamgate_list_users). |
| stage_id | integer | Pipeline stage id (see teamgate_get_pipeline). |
| price_value | number | Deal value. |
| price_currency | string |
WRITE: create a lead. Give a person's name, or a company_name for a company lead. Teamgate may start workflows or notifications for new leads. POST /leads.
| Argument | Type | Description |
|---|---|---|
| name | string | Person's full name (required unless company_name is given). |
| tags | array | Tags to set on the record. |
| string | Email address. | |
| phone | string | Phone number. |
| source | string | Source name (created if it does not exist). |
| status | string | Lead status name, e.g. 'New' (created if it does not exist). |
| starred | boolean | Star the record. |
| industry | string | Industry name (created if it does not exist). |
| owner_id | integer | Owner user id (see teamgate_list_users). |
| job_title |
WRITE: create a person (contact). Optionally link them to a company with their job title. POST /people.
| Argument | Type | Description |
|---|---|---|
| name* | string | Person's full name. |
| tags | array | Tags to set on the record. |
| string | Email address. | |
| phone | string | Phone number. |
| source | string | Source name (created if it does not exist). |
| starred | boolean | Star the record. |
| industry | string | Industry name (created if it does not exist). |
| owner_id | integer | Owner user id (see teamgate_list_users). |
| job_title | string | Job title (used only together with company_id). |
| company_id | integer |
One activity (task, call, appointment or note) by id. GET /events/{id}.
| Argument | Type | Description |
|---|---|---|
| activity_id* | integer | Teamgate activity id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"activity_id"
],
"properties": {
"activity_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Teamgate activity id.",
"exclusiveMinimum": 0
}
}
}One company by id with all its details. GET /companies/{id}.
| Argument | Type | Description |
|---|---|---|
| company_id* | integer | Teamgate company id. |
| include_custom_fields | boolean | Include custom field values in the reply (default false). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company_id"
],
"properties": {
"company_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Teamgate company id.",
"exclusiveMinimum": 0
},
"include_custom_fields": {
"type": "boolean",
"description": "Include custom field values in the reply (default false)."
}
}
}One deal by id with value, stage, status, owner, buyer and dates. GET /deals/{id}.
| Argument | Type | Description |
|---|---|---|
| deal_id* | integer | Teamgate deal id. |
| include_custom_fields | boolean | Include custom field values in the reply (default false). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"deal_id"
],
"properties": {
"deal_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Teamgate deal id.",
"exclusiveMinimum": 0
},
"include_custom_fields": {
"type": "boolean",
"description": "Include custom field values in the reply (default false)."
}
}
}One lead by id with all its details. GET /leads/{id}.
| Argument | Type | Description |
|---|---|---|
| lead_id* | integer | Teamgate lead id. |
| include_custom_fields | boolean | Include custom field values in the reply (default false). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"lead_id"
],
"properties": {
"lead_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Teamgate lead id.",
"exclusiveMinimum": 0
},
"include_custom_fields": {
"type": "boolean",
"description": "Include custom field values in the reply (default false)."
}
}
}One person by id with all their details. GET /people/{id}.
| Argument | Type | Description |
|---|---|---|
| person_id* | integer | Teamgate person id. |
| include_custom_fields | boolean | Include custom field values in the reply (default false). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"person_id"
],
"properties": {
"person_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Teamgate person id.",
"exclusiveMinimum": 0
},
"include_custom_fields": {
"type": "boolean",
"description": "Include custom field values in the reply (default false)."
}
}
}One sales pipeline by id, with its stages. GET /pipelines/{id}.
| Argument | Type | Description |
|---|---|---|
| pipeline_id* | integer | Teamgate pipeline id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"pipeline_id"
],
"properties": {
"pipeline_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Teamgate pipeline id.",
"exclusiveMinimum": 0
}
}
}One Teamgate user by id. GET /users/{id}.
| Argument | Type | Description |
|---|---|---|
| user_id* | integer | Teamgate user id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"user_id"
],
"properties": {
"user_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Teamgate user id.",
"exclusiveMinimum": 0
}
}
}List activities (tasks, calls, appointments and notes) across the account. GET /events.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 25). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
}
}
}List or search companies with owner, industry, source, customer and prospect status and contact details. Filter by name, email, phone, owner, VAT code or creation date. GET /companies.
| Argument | Type | Description |
|---|---|---|
| name | string | Part of the company name. |
| string | Part of an email address (at least 3 characters). | |
| limit | integer | Results per page, 1-100 (default 25). |
| phone | string | The last digits of a phone number (at least 3 characters). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
| owner_id | integer | Only companies owned by this user id. |
| vat_code | string | Exact VAT identification number. |
| created_after | string | Only companies created at or after this RFC 3339 date or date-time. |
| created_before | string |
List the people who work at one company. GET /companies/{id}/people.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 25). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
| company_id* | integer | Teamgate company id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
},
"company_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Teamgate company id.",
"exclusiveMinimum": 0
}
}
}List the deals that belong to one person or one company. GET /people/{id}/deals or /companies/{id}/deals.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 25). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
| contact_id* | integer | Teamgate person or company id. |
| contact_type* | string | Whether contact_id is a person or a company. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"contact_type",
"contact_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
},
"contact_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Teamgate person or company id.",
"exclusiveMinimum": 0
},
"contact_type": {
"enum": [
"people",
"companies"
],
"type": "string",
"description": "Whether contact_id is a person or a company."
}
}
}List the custom field definitions of the account (id, name, type, module). GET /customFields.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 25). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
}
}
}List the pipeline stages that one deal can be in (id, name, win probability; the deal's current stage is marked selected). GET /deals/{id}/stages.
| Argument | Type | Description |
|---|---|---|
| deal_id* | integer | Teamgate deal id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"deal_id"
],
"properties": {
"deal_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Teamgate deal id.",
"exclusiveMinimum": 0
}
}
}List or search deals (sales opportunities) with value, stage, status, owner and expected closing date. Filter by name, status, stage, owner, source or creation date. GET /deals.
| Argument | Type | Description |
|---|---|---|
| name | string | Part of the deal name. |
| limit | integer | Results per page, 1-100 (default 25). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
| source | string | Exact source name. |
| status | string | Deal status. |
| owner_id | integer | Only deals owned by this user id. |
| stage_id | integer | Only deals in this pipeline stage id (see teamgate_get_pipeline). |
| created_after | string | Only deals created at or after this RFC 3339 date or date-time. |
| created_before | string | Only deals created at or before this RFC 3339 date or date-time. |
List the industries of the account. GET /industries.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 25). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
}
}
}List the lead statuses of the account (use the names as the status filter or value on leads). GET /leadsStatuses.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 25). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
}
}
}List or search leads (unqualified prospects) with owner, status, source, industry and contact details. Filter by name, email, phone, status, owner, source, star or creation date. GET /leads.
| Argument | Type | Description |
|---|---|---|
| name | string | Part of the lead's name. |
| string | Part of an email address (at least 3 characters). | |
| limit | integer | Results per page, 1-100 (default 25). |
| phone | string | The last digits of a phone number (at least 3 characters). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
| source | string | Exact source name. |
| status | string | Exact lead status name, e.g. 'New'. See teamgate_list_lead_statuses. |
| starred | boolean | Only starred (true) or not starred (false) leads. |
| owner_id | integer | Only leads owned by this user id. |
List or search people (contacts) with job title, company, owner, source and contact details. Filter by name, email, phone, owner, customer status or creation date. GET /people.
| Argument | Type | Description |
|---|---|---|
| name | string | Part of the person's name. |
| string | Part of an email address (at least 3 characters). | |
| limit | integer | Results per page, 1-100 (default 25). |
| phone | string | The last digits of a phone number (at least 3 characters). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
| owner_id | integer | Only people owned by this user id. |
| created_after | string | Only people created at or after this RFC 3339 date or date-time. |
| created_before | string | Only people created at or before this RFC 3339 date or date-time. |
| customer_status | integer |
List the sales pipelines (id and name). Use teamgate_get_pipeline for the stages of one. GET /pipelines.
| Argument | Type | Description |
|---|---|---|
| name | string | Part of the pipeline name. |
| limit | integer | Results per page, 1-100 (default 25). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Part of the pipeline name."
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
}
}
}List the products of the catalogue (id, name, price). GET /products.
| Argument | Type | Description |
|---|---|---|
| name | string | Part of the product name. |
| limit | integer | Results per page, 1-100 (default 25). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Part of the product name."
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
}
}
}List the activities (tasks, calls, appointments, notes) linked to one lead, person, company or deal. GET /{leads|people|companies|deals}/{id}/events.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 25). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
| record_id* | integer | Teamgate id of the lead, person, company or deal. |
| record_type* | string | The kind of record. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"record_type",
"record_id"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
},
"record_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Teamgate id of the lead, person, company or deal.",
"exclusiveMinimum": 0
},
"record_type": {
"enum": [
"leads",
"people",
"companies",
"deals"
],
"type": "string",
"description": "The kind of record."
}
}
}List the lead/deal sources of the account (where records come from). GET /sources.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 25). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
}
}
}List the Teamgate users of the account with id, name and username. Use the ids as owner_id filters and values. GET /users.
| Argument | Type | Description |
|---|---|---|
| name | string | Part of the user's first name. |
| string | Exact email of the user. | |
| limit | integer | Results per page, 1-100 (default 25). |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
| is_active | boolean | Only active (true) or only inactive (false) users. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Part of the user's first name."
},
"email": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Exact email of the user."
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
},
"is_active": {
"type": "boolean",
"description": "Only active (true) or only inactive (false) users."
}
}
}Search leads, people, companies and deals by name in one request. GET /global.
| Argument | Type | Description |
|---|---|---|
| limit | integer | Results per page, 1-100 (default 25). |
| query* | string | Text to find in record names. |
| offset | integer | Records to skip (default 0). Pass the previous reply's next_offset. |
| modules | array | Which kinds of record to search (default all four). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"query"
],
"properties": {
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"query": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Text to find in record names."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
},
"modules": {
"type": "array",
"items": {
"enum": [
"leads",
"people",
"companies",
"deals"
],
"type": "string"
},
"maxItems": 4,
"minItems": 1,
"description": "Which kinds of record to search (default all four)."
}
}
}WRITE: change fields of one company. Only the fields you pass are sent; this overwrites their current values. PUT /companies/{id}.
| Argument | Type | Description |
|---|---|---|
| name | string | New name. |
| tags | array | Tags to set on the record. |
| source | string | Source name (created if it does not exist). |
| starred | boolean | Star the record. |
| industry | string | Industry name (created if it does not exist). |
| owner_id | integer | Owner user id (see teamgate_list_users). |
| vat_code | string | VAT identification number. |
| company_id* | integer | Teamgate company id. |
| customer_status | integer | 0 = non customer, 1 = past customer, 2 = customer. |
WRITE: change fields of one deal, for example move it to another stage or mark it won or lost. Only the fields you pass are sent; this overwrites their current values. PUT /deals/{id}.
| Argument | Type | Description |
|---|---|---|
| name | string | New deal name. |
| tags | array | Tags to set on the record. |
| source | string | Source name (created if it does not exist). |
| status | string | Deal status. |
| deal_id* | integer | Teamgate deal id. |
| starred | boolean | Star the record. |
| buyer_id | integer | New buyer (person or company id). |
| owner_id | integer | Owner user id (see teamgate_list_users). |
| stage_id | integer | Pipeline stage id (see teamgate_get_pipeline). |
| price_value |
WRITE: change fields of one lead. Only the fields you pass are sent; this overwrites their current values. PUT /leads/{id}.
| Argument | Type | Description |
|---|---|---|
| name | string | New name. |
| tags | array | Tags to set on the record. |
| source | string | Source name (created if it does not exist). |
| status | string | New lead status name. |
| lead_id* | integer | Teamgate lead id. |
| starred | boolean | Star the record. |
| industry | string | Industry name (created if it does not exist). |
| owner_id | integer | Owner user id (see teamgate_list_users). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"lead_id"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "New name."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 20,
"minItems": 1,
"description": "Tags to set on the record."
},
"source": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Source name (created if it does not exist)."
},
"status": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "New lead status name."
},
"lead_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Teamgate lead id.",
"exclusiveMinimum": 0
},
"starred": {
"type": "boolean",
"description": "Star the record."
},
"industry": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Industry name (created if it does not exist)."
},
"owner_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Owner user id (see teamgate_list_users).",
"exclusiveMinimum": 0
}
}
}WRITE: change fields of one person. Only the fields you pass are sent; this overwrites their current values. PUT /people/{id}.
| Argument | Type | Description |
|---|---|---|
| name | string | New name. |
| tags | array | Tags to set on the record. |
| source | string | Source name (created if it does not exist). |
| starred | boolean | Star the record. |
| industry | string | Industry name (created if it does not exist). |
| owner_id | integer | Owner user id (see teamgate_list_users). |
| person_id* | integer | Teamgate person id. |
| customer_status | integer | 0 = non customer, 1 = past customer, 2 = customer. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"person_id"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "New name."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 20,
"minItems": 1,
"description": "Tags to set on the record."
},
"source": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Source name (created if it does not exist)."
},
"starred": {
"type": "boolean",
"description": "Star the record."
},
"industry": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Industry name (created if it does not exist)."
},
"owner_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Owner user id (see teamgate_list_users).",
"exclusiveMinimum": 0
},
"person_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Teamgate person id.",
"exclusiveMinimum": 0
},
"customer_status": {
"type": "integer",
"maximum": 2,
"minimum": 0,
"description": "0 = non customer, 1 = past customer, 2 = customer."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"type",
"name"
],
"properties": {
"end": {
"type": "string",
"description": "End (RFC 3339 date-time with timezone)."
},
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Activity title."
},
"type": {
"enum": [
"task",
"call",
"appointment"
],
"type": "string",
"description": "Kind of activity."
},
"start": {
"type": "string",
"description": "Start (RFC 3339 date-time with timezone)."
},
"deal_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 20,
"minItems": 1,
"description": "Deals to link."
},
"lead_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 20,
"minItems": 1,
"description": "Leads to link."
},
"owner_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Owner user id (see teamgate_list_users).",
"exclusiveMinimum": 0
},
"company_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"exclusiveMinimum": 0
},
"maxItems": 20,
"minItems": 1,
"description": "Companies to link."
},
"description": {
"type": "string",
"maxLength": 5000,
"minLength": 1,
"description": "Details."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Company name."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 20,
"minItems": 1,
"description": "Tags to set on the record."
},
"email": {
"type": "string",
"maxLength": 254,
"minLength": 1,
"description": "Email address."
},
"phone": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Phone number."
},
"source": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Source name (created if it does not exist)."
},
"starred": {
"type": "boolean",
"description": "Star the record."
},
"industry": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Industry name (created if it does not exist)."
},
"owner_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Owner user id (see teamgate_list_users).",
"exclusiveMinimum": 0
},
"vat_code": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "VAT identification number."
},
"customer_status": {
"type": "integer",
"maximum": 2,
"minimum": 0,
"description": "0 = non customer, 1 = past customer, 2 = customer."
}
}
}| Currency code, e.g. EUR. |
| estimated_closure_date | string | Expected closing date-time (RFC 3339 with timezone). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"buyer_id"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Deal name."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 20,
"minItems": 1,
"description": "Tags to set on the record."
},
"source": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Source name (created if it does not exist)."
},
"status": {
"enum": [
"active",
"won",
"lost",
"postponed"
],
"type": "string",
"description": "Deal status."
},
"starred": {
"type": "boolean",
"description": "Star the record."
},
"buyer_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Id of the person or company that buys, as returned by the list tools.",
"exclusiveMinimum": 0
},
"owner_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Owner user id (see teamgate_list_users).",
"exclusiveMinimum": 0
},
"stage_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Pipeline stage id (see teamgate_get_pipeline).",
"exclusiveMinimum": 0
},
"price_value": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0,
"description": "Deal value."
},
"price_currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$",
"description": "Currency code, e.g. EUR."
},
"estimated_closure_date": {
"type": "string",
"description": "Expected closing date-time (RFC 3339 with timezone)."
}
}
}| string |
| Job title (used only together with company_name). |
| company_name | string | Company name for a company lead (required unless name is given). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Person's full name (required unless company_name is given)."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 20,
"minItems": 1,
"description": "Tags to set on the record."
},
"email": {
"type": "string",
"maxLength": 254,
"minLength": 1,
"description": "Email address."
},
"phone": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Phone number."
},
"source": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Source name (created if it does not exist)."
},
"status": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Lead status name, e.g. 'New' (created if it does not exist)."
},
"starred": {
"type": "boolean",
"description": "Star the record."
},
"industry": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Industry name (created if it does not exist)."
},
"owner_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Owner user id (see teamgate_list_users).",
"exclusiveMinimum": 0
},
"job_title": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Job title (used only together with company_name)."
},
"company_name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Company name for a company lead (required unless name is given)."
}
}
}| Id of the company the person works at. |
| customer_status | integer | 0 = non customer, 1 = past customer, 2 = customer. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Person's full name."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 20,
"minItems": 1,
"description": "Tags to set on the record."
},
"email": {
"type": "string",
"maxLength": 254,
"minLength": 1,
"description": "Email address."
},
"phone": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Phone number."
},
"source": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Source name (created if it does not exist)."
},
"starred": {
"type": "boolean",
"description": "Star the record."
},
"industry": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Industry name (created if it does not exist)."
},
"owner_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Owner user id (see teamgate_list_users).",
"exclusiveMinimum": 0
},
"job_title": {
"type": "string",
"maxLength": 100,
"minLength": 1,
"description": "Job title (used only together with company_id)."
},
"company_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Id of the company the person works at.",
"exclusiveMinimum": 0
},
"customer_status": {
"type": "integer",
"maximum": 2,
"minimum": 0,
"description": "0 = non customer, 1 = past customer, 2 = customer."
}
}
}| Only companies created at or before this RFC 3339 date or date-time. |
| customer_status | integer | 0 = non customer, 1 = past customer, 2 = customer. |
| include_custom_fields | boolean | Include custom field values in the reply (default false). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Part of the company name."
},
"email": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Part of an email address (at least 3 characters)."
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"phone": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "The last digits of a phone number (at least 3 characters)."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
},
"owner_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only companies owned by this user id.",
"exclusiveMinimum": 0
},
"vat_code": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "Exact VAT identification number."
},
"created_after": {
"type": "string",
"description": "Only companies created at or after this RFC 3339 date or date-time."
},
"created_before": {
"type": "string",
"description": "Only companies created at or before this RFC 3339 date or date-time."
},
"customer_status": {
"type": "integer",
"maximum": 2,
"minimum": 0,
"description": "0 = non customer, 1 = past customer, 2 = customer."
},
"include_custom_fields": {
"type": "boolean",
"description": "Include custom field values in the reply (default false)."
}
}
}| include_custom_fields | boolean | Include custom field values in the reply (default false). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Part of the deal name."
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
},
"source": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Exact source name."
},
"status": {
"enum": [
"active",
"won",
"lost",
"postponed"
],
"type": "string",
"description": "Deal status."
},
"owner_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only deals owned by this user id.",
"exclusiveMinimum": 0
},
"stage_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only deals in this pipeline stage id (see teamgate_get_pipeline).",
"exclusiveMinimum": 0
},
"created_after": {
"type": "string",
"description": "Only deals created at or after this RFC 3339 date or date-time."
},
"created_before": {
"type": "string",
"description": "Only deals created at or before this RFC 3339 date or date-time."
},
"include_custom_fields": {
"type": "boolean",
"description": "Include custom field values in the reply (default false)."
}
}
}| created_after | string | Only leads created at or after this RFC 3339 date or date-time. |
| created_before | string | Only leads created at or before this RFC 3339 date or date-time. |
| include_custom_fields | boolean | Include custom field values in the reply (default false). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Part of the lead's name."
},
"email": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Part of an email address (at least 3 characters)."
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"phone": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "The last digits of a phone number (at least 3 characters)."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
},
"source": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Exact source name."
},
"status": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Exact lead status name, e.g. 'New'. See teamgate_list_lead_statuses."
},
"starred": {
"type": "boolean",
"description": "Only starred (true) or not starred (false) leads."
},
"owner_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only leads owned by this user id.",
"exclusiveMinimum": 0
},
"created_after": {
"type": "string",
"description": "Only leads created at or after this RFC 3339 date or date-time."
},
"created_before": {
"type": "string",
"description": "Only leads created at or before this RFC 3339 date or date-time."
},
"include_custom_fields": {
"type": "boolean",
"description": "Include custom field values in the reply (default false)."
}
}
}| 0 = non customer, 1 = past customer, 2 = customer. |
| include_custom_fields | boolean | Include custom field values in the reply (default false). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Part of the person's name."
},
"email": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Part of an email address (at least 3 characters)."
},
"limit": {
"type": "integer",
"maximum": 100,
"description": "Results per page, 1-100 (default 25).",
"exclusiveMinimum": 0
},
"phone": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "The last digits of a phone number (at least 3 characters)."
},
"offset": {
"type": "integer",
"maximum": 1000000,
"minimum": 0,
"description": "Records to skip (default 0). Pass the previous reply's next_offset."
},
"owner_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Only people owned by this user id.",
"exclusiveMinimum": 0
},
"created_after": {
"type": "string",
"description": "Only people created at or after this RFC 3339 date or date-time."
},
"created_before": {
"type": "string",
"description": "Only people created at or before this RFC 3339 date or date-time."
},
"customer_status": {
"type": "integer",
"maximum": 2,
"minimum": 0,
"description": "0 = non customer, 1 = past customer, 2 = customer."
},
"include_custom_fields": {
"type": "boolean",
"description": "Include custom field values in the reply (default false)."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"company_id"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "New name."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 20,
"minItems": 1,
"description": "Tags to set on the record."
},
"source": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Source name (created if it does not exist)."
},
"starred": {
"type": "boolean",
"description": "Star the record."
},
"industry": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Industry name (created if it does not exist)."
},
"owner_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Owner user id (see teamgate_list_users).",
"exclusiveMinimum": 0
},
"vat_code": {
"type": "string",
"maxLength": 50,
"minLength": 1,
"description": "VAT identification number."
},
"company_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Teamgate company id.",
"exclusiveMinimum": 0
},
"customer_status": {
"type": "integer",
"maximum": 2,
"minimum": 0,
"description": "0 = non customer, 1 = past customer, 2 = customer."
}
}
}| number |
| Deal value. |
| price_currency | string | Currency code, e.g. EUR. |
| estimated_closure_date | string | Expected closing date-time (RFC 3339 with timezone). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"deal_id"
],
"properties": {
"name": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "New deal name."
},
"tags": {
"type": "array",
"items": {
"type": "string",
"maxLength": 100,
"minLength": 1
},
"maxItems": 20,
"minItems": 1,
"description": "Tags to set on the record."
},
"source": {
"type": "string",
"maxLength": 255,
"minLength": 1,
"description": "Source name (created if it does not exist)."
},
"status": {
"enum": [
"active",
"won",
"lost",
"postponed"
],
"type": "string",
"description": "Deal status."
},
"deal_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Teamgate deal id.",
"exclusiveMinimum": 0
},
"starred": {
"type": "boolean",
"description": "Star the record."
},
"buyer_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "New buyer (person or company id).",
"exclusiveMinimum": 0
},
"owner_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Owner user id (see teamgate_list_users).",
"exclusiveMinimum": 0
},
"stage_id": {
"type": "integer",
"maximum": 9007199254740991,
"description": "Pipeline stage id (see teamgate_get_pipeline).",
"exclusiveMinimum": 0
},
"price_value": {
"type": "number",
"maximum": 1000000000000,
"minimum": 0,
"description": "Deal value."
},
"price_currency": {
"type": "string",
"pattern": "^[A-Za-z]{3}$",
"description": "Currency code, e.g. EUR."
},
"estimated_closure_date": {
"type": "string",
"description": "Expected closing date-time (RFC 3339 with timezone)."
}
}
}