Servers Playground How we check Add a server Log in

Cogmento MCP by usefulapi

Working · 1.6 s

io.usefulapi/cogmentov1.0.0 Domain verified

Read Cogmento CRM contacts, companies, deals, tasks and cases; create records and complete tasks.

Sales & CRM

Source Website Registry entry

Maintain this server? Claim it

Try it

Call this server's tools from your browser. Nothing to install.

https://cogmento.usefulapi.io/mcp

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.

cogmento_aggregate_deals Read-only

Sums and counts deals grouped by a field (default grouping as Cogmento chooses; e.g. field=stage). GET /deals/aggregate/.

fieldstring

Field to group by, e.g. stage.

filtersarray

Conditions, all of which must match (AND). Dates are yyyy-mm-dd.

Cogmento MCP by usefulapi MCP server | mcptry

Tools (26)

cogmento_aggregate_deals

Sums and counts deals grouped by a field (default grouping as Cogmento chooses; e.g. field=stage). GET /deals/aggregate/.

read-only

Argument	Type	Description
field	string	Field to group by, e.g. stage.
filters	array	Conditions, all of which must match (AND). Dates are yyyy-mm-dd.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "field": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9_]{0,63}$",
      "description": "Field to group by, e.g. stage."
    },
    "filters": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "field",
          "operator",
          "value"
        ],
        "properties": {
          "field": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]{0,63}$",
            "description": "Field name, e.g. first_name, title, status."
          },
          "value": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              }
            ],
            "description": "Value to compare with."
          },
          "operator": {
            "enum": [
              "eq",
              "gt",
              "gte",
              "lt",
              "lte",
              "contains"
            ],
            "type": "string",
            "description": "eq, gt, gte, lt, lte or contains."
          }
        }
      },
      "maxItems": 10,
      "minItems": 1,
      "description": "Conditions, all of which must match (AND). Dates are yyyy-mm-dd."
    }
  }
}

cogmento_complete_task

WRITE: mark a task complete, stamping who completed it and when. A recurring task also gets its next occurrence. POST /tasks/{id}/complete/.

destructive

Argument	Type	Description
task_id*	string	Record id (UUID).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "task_id"
  ],
  "properties": {
    "task_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Record id (UUID)."
    }
  }
}

cogmento_create_case

WRITE: create a case. POST /cases/.

Argument	Type	Description
tags	array	Tags to put on the record.
title*	string
rating	integer	A 1-5 rating.
close_date	string	A date, yyyy-mm-dd.
description	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "title"
  ],
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 50,
      "description": "Tags to put on the record."
    },
    "title": {
      "type": "string",
      "maxLength": 300,
      "minLength": 1
    },
    "rating": {
      "type": "integer",
      "maximum": 5,
      "minimum": 1,
      "description": "A 1-5 rating."
    },
    "close_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "A date, yyyy-mm-dd."
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "minLength": 1
    }
  }
}

cogmento_create_company

WRITE: create a company. POST /companies/.

Argument	Type	Description
url	string	The company's website.
name*	string
tags	array	Tags to put on the record.
rating	integer	A 1-5 rating.
description	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "name"
  ],
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "maxLength": 500,
      "description": "The company's website."
    },
    "name": {
      "type": "string",
      "maxLength": 300,
      "minLength": 1
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 50,
      "description": "Tags to put on the record."
    },
    "rating": {
      "type": "integer",
      "maximum": 5,
      "minimum": 1,
      "description": "A 1-5 rating."
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "minLength": 1
    }
  }
}

cogmento_create_contact

WRITE: create a contact. Needs first and last name; email and phone are optional. POST /contacts/.

Argument	Type	Description
tags	array	Tags to put on the record.
email	string	Email address; stored as an Email channel.
phone	string	Phone number, ideally in international format (+14155550100).
rating	integer	A 1-5 rating.
last_name*	string
first_name*	string
description	string
middle_name	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "first_name",
    "last_name"
  ],
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 50,
      "description": "Tags to put on the record."
    },
    "email": {
      "type": "string",
      "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,}$",
      "maxLength": 320,
      "description": "Email address; stored as an Email channel."
    },
    "phone": {
      "type": "string",
      "maxLength": 40,
      "minLength": 3,
      "description": "Phone number, ideally in international format (+14155550100)."
    },
    "rating": {
      "type": "integer",
      "maximum": 5,
      "minimum": 1,
      "description": "A 1-5 rating."
    },
    "last_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "first_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "minLength": 1
    },
    "middle_name": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1
    }
  }
}

cogmento_create_deal

WRITE: create a deal. POST /deals/.

Argument	Type	Description
tags	array	Tags to put on the record.
title*	string
amount	number	The deal value.
rating	integer	A 1-5 rating.
close_date	string	A date, yyyy-mm-dd.
description	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "title"
  ],
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 50,
      "description": "Tags to put on the record."
    },
    "title": {
      "type": "string",
      "maxLength": 300,
      "minLength": 1
    },
    "amount": {
      "type": "number",
      "maximum": 1000000000000000,
      "minimum": 0,
      "description": "The deal value."
    },
    "rating": {
      "type": "integer",
      "maximum": 5,
      "minimum": 1,
      "description": "A 1-5 rating."
    },
    "close_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "A date, yyyy-mm-dd."
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "minLength": 1
    }
  }
}

cogmento_create_task

WRITE: create a task. POST /tasks/.

Argument	Type	Description
tags	array	Tags to put on the record.
title*	string
rating	integer	A 1-5 rating.
due_date	string	A date, yyyy-mm-dd.
description	string

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "title"
  ],
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 100,
        "minLength": 1
      },
      "maxItems": 50,
      "description": "Tags to put on the record."
    },
    "title": {
      "type": "string",
      "maxLength": 300,
      "minLength": 1
    },
    "rating": {
      "type": "integer",
      "maximum": 5,
      "minimum": 1,
      "description": "A 1-5 rating."
    },
    "due_date": {
      "type": "string",
      "pattern": "^\\d{4}-\\d{2}-\\d{2}$",
      "description": "A date, yyyy-mm-dd."
    },
    "description": {
      "type": "string",
      "maxLength": 5000,
      "minLength": 1
    }
  }
}

cogmento_get_account

The Cogmento account: name, country, settings, billing plan, trial days left and number of users. GET /account/.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

cogmento_get_case

One case record. GET /cases/{id}/.

read-only

Argument	Type	Description
case_id*	string	Record id (UUID).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "case_id"
  ],
  "properties": {
    "case_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Record id (UUID)."
    }
  }
}

cogmento_get_company

One full company record with its contacts and related records. GET /companies/{id}/.

read-only

Argument	Type	Description
company_id*	string	Record id (UUID).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "company_id"
  ],
  "properties": {
    "company_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Record id (UUID)."
    }
  }
}

cogmento_get_contact

One full contact record, including its related tasks, cases, calls, events and documents. GET /contacts/{id}/.

read-only

Argument	Type	Description
contact_id*	string	Record id (UUID).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "contact_id"
  ],
  "properties": {
    "contact_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Record id (UUID)."
    }
  }
}

cogmento_get_current_user

The Cogmento user this API token belongs to: id, name, email, timezone and account id. GET /auth/user/.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

cogmento_get_deal

One full deal record with its contacts, products and related records. GET /deals/{id}/.

read-only

Argument	Type	Description
deal_id*	string	Record id (UUID).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "deal_id"
  ],
  "properties": {
    "deal_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Record id (UUID)."
    }
  }
}

cogmento_get_deal_pipeline_summary

Totals by pipeline stage: how many deals sit at each stage and what they are worth. Optional filters narrow the deals counted. GET /deals/summary/.

read-only

Argument	Type	Description
filters	array	Conditions, all of which must match (AND). Dates are yyyy-mm-dd.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "filters": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "field",
          "operator",
          "value"
        ],
        "properties": {
          "field": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]{0,63}$",
            "description": "Field name, e.g. first_name, title, status."
          },
          "value": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              }
            ],
            "description": "Value to compare with."
          },
          "operator": {
            "enum": [
              "eq",
              "gt",
              "gte",
              "lt",
              "lte",
              "contains"
            ],
            "type": "string",
            "description": "eq, gt, gte, lt, lte or contains."
          }
        }
      },
      "maxItems": 10,
      "minItems": 1,
      "description": "Conditions, all of which must match (AND). Dates are yyyy-mm-dd."
    }
  }
}

cogmento_get_task

One task record. GET /tasks/{id}/.

read-only

Argument	Type	Description
task_id*	string	Record id (UUID).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "task_id"
  ],
  "properties": {
    "task_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Record id (UUID)."
    }
  }
}

cogmento_get_templates

The field definitions (names, labels, types, options) of the account's templates for each record type: contacts, companies, deals, cases, tasks. Use it to learn the custom field names for filters, creates and field updates. GET /templates/.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

cogmento_list_calls

The account's call records, most recent first: logged manual calls and calls placed through the browser dialer. GET /calls/.

read-only

Argument	Type	Description
sort	string	Field to sort by, e.g. created_at; prefix with - for descending, e.g. -last_modified.
limit	integer	Rows per page, 1-100 (default 25).
start	integer	Row offset to start from (default 0). Pass the previous reply's next_start.
filters	array	Conditions, all of which must match (AND). Dates are yyyy-mm-dd.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "sort": {
      "type": "string",
      "pattern": "^-?[a-z][a-z0-9_]{0,63}$",
      "description": "Field to sort by, e.g. created_at; prefix with - for descending, e.g. -last_modified."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Rows per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "start": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Row offset to start from (default 0). Pass the previous reply's next_start."
    },
    "filters": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "field",
          "operator",
          "value"
        ],
        "properties": {
          "field": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]{0,63}$",
            "description": "Field name, e.g. first_name, title, status."
          },
          "value": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              }
            ],
            "description": "Value to compare with."
          },
          "operator": {
            "enum": [
              "eq",
              "gt",
              "gte",
              "lt",
              "lte",
              "contains"
            ],
            "type": "string",
            "description": "eq, gt, gte, lt, lte or contains."
          }
        }
      },
      "maxItems": 10,
      "minItems": 1,
      "description": "Conditions, all of which must match (AND). Dates are yyyy-mm-dd."
    }
  }
}

cogmento_list_cases

List or search cases (support or project cases: title, close date, assigned users, deal, company). GET /cases/.

read-only

Argument	Type	Description
sort	string	Field to sort by, e.g. created_at; prefix with - for descending, e.g. -last_modified.
limit	integer	Rows per page, 1-100 (default 25).
start	integer	Row offset to start from (default 0). Pass the previous reply's next_start.
filters	array	Conditions, all of which must match (AND). Dates are yyyy-mm-dd.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "sort": {
      "type": "string",
      "pattern": "^-?[a-z][a-z0-9_]{0,63}$",
      "description": "Field to sort by, e.g. created_at; prefix with - for descending, e.g. -last_modified."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Rows per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "start": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Row offset to start from (default 0). Pass the previous reply's next_start."
    },
    "filters": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "field",
          "operator",
          "value"
        ],
        "properties": {
          "field": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]{0,63}$",
            "description": "Field name, e.g. first_name, title, status."
          },
          "value": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              }
            ],
            "description": "Value to compare with."
          },
          "operator": {
            "enum": [
              "eq",
              "gt",
              "gte",
              "lt",
              "lte",
              "contains"
            ],
            "type": "string",
            "description": "eq, gt, gte, lt, lte or contains."
          }
        }
      },
      "maxItems": 10,
      "minItems": 1,
      "description": "Conditions, all of which must match (AND). Dates are yyyy-mm-dd."
    }
  }
}

cogmento_list_companies

List or search companies (name, website, contacts). GET /companies/.

read-only

Argument	Type	Description
sort	string	Field to sort by, e.g. created_at; prefix with - for descending, e.g. -last_modified.
limit	integer	Rows per page, 1-100 (default 25).
start	integer	Row offset to start from (default 0). Pass the previous reply's next_start.
filters	array	Conditions, all of which must match (AND). Dates are yyyy-mm-dd.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "sort": {
      "type": "string",
      "pattern": "^-?[a-z][a-z0-9_]{0,63}$",
      "description": "Field to sort by, e.g. created_at; prefix with - for descending, e.g. -last_modified."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Rows per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "start": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Row offset to start from (default 0). Pass the previous reply's next_start."
    },
    "filters": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "field",
          "operator",
          "value"
        ],
        "properties": {
          "field": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]{0,63}$",
            "description": "Field name, e.g. first_name, title, status."
          },
          "value": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              }
            ],
            "description": "Value to compare with."
          },
          "operator": {
            "enum": [
              "eq",
              "gt",
              "gte",
              "lt",
              "lte",
              "contains"
            ],
            "type": "string",
            "description": "eq, gt, gte, lt, lte or contains."
          }
        }
      },
      "maxItems": 10,
      "minItems": 1,
      "description": "Conditions, all of which must match (AND). Dates are yyyy-mm-dd."
    }
  }
}

cogmento_list_contacts

List or search contacts (name, email and phone channels, company). Filter on any field, e.g. first_name contains 'Eric'. GET /contacts/.

read-only

Argument	Type	Description
sort	string	Field to sort by, e.g. created_at; prefix with - for descending, e.g. -last_modified.
limit	integer	Rows per page, 1-100 (default 25).
start	integer	Row offset to start from (default 0). Pass the previous reply's next_start.
filters	array	Conditions, all of which must match (AND). Dates are yyyy-mm-dd.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "sort": {
      "type": "string",
      "pattern": "^-?[a-z][a-z0-9_]{0,63}$",
      "description": "Field to sort by, e.g. created_at; prefix with - for descending, e.g. -last_modified."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Rows per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "start": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Row offset to start from (default 0). Pass the previous reply's next_start."
    },
    "filters": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "field",
          "operator",
          "value"
        ],
        "properties": {
          "field": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]{0,63}$",
            "description": "Field name, e.g. first_name, title, status."
          },
          "value": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              }
            ],
            "description": "Value to compare with."
          },
          "operator": {
            "enum": [
              "eq",
              "gt",
              "gte",
              "lt",
              "lte",
              "contains"
            ],
            "type": "string",
            "description": "eq, gt, gte, lt, lte or contains."
          }
        }
      },
      "maxItems": 10,
      "minItems": 1,
      "description": "Conditions, all of which must match (AND). Dates are yyyy-mm-dd."
    }
  }
}

cogmento_list_deal_stages

The account-wide stages a contact can be at within a deal (for example Champion or Decision maker). GET /deals/stages/.

read-only

No arguments.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {}
}

cogmento_list_deals

List or search deals (title, amount, close date, assigned users, products). GET /deals/.

read-only

Argument	Type	Description
sort	string	Field to sort by, e.g. created_at; prefix with - for descending, e.g. -last_modified.
limit	integer	Rows per page, 1-100 (default 25).
start	integer	Row offset to start from (default 0). Pass the previous reply's next_start.
filters	array	Conditions, all of which must match (AND). Dates are yyyy-mm-dd.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "sort": {
      "type": "string",
      "pattern": "^-?[a-z][a-z0-9_]{0,63}$",
      "description": "Field to sort by, e.g. created_at; prefix with - for descending, e.g. -last_modified."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Rows per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "start": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Row offset to start from (default 0). Pass the previous reply's next_start."
    },
    "filters": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "field",
          "operator",
          "value"
        ],
        "properties": {
          "field": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]{0,63}$",
            "description": "Field name, e.g. first_name, title, status."
          },
          "value": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              }
            ],
            "description": "Value to compare with."
          },
          "operator": {
            "enum": [
              "eq",
              "gt",
              "gte",
              "lt",
              "lte",
              "contains"
            ],
            "type": "string",
            "description": "eq, gt, gte, lt, lte or contains."
          }
        }
      },
      "maxItems": 10,
      "minItems": 1,
      "description": "Conditions, all of which must match (AND). Dates are yyyy-mm-dd."
    }
  }
}

cogmento_list_products

List the product catalogue (name, prices) that deals and invoices draw on. GET /products/.

read-only

Argument	Type	Description
sort	string	Field to sort by, e.g. created_at; prefix with - for descending, e.g. -last_modified.
limit	integer	Rows per page, 1-100 (default 25).
start	integer	Row offset to start from (default 0). Pass the previous reply's next_start.
filters	array	Conditions, all of which must match (AND). Dates are yyyy-mm-dd.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "sort": {
      "type": "string",
      "pattern": "^-?[a-z][a-z0-9_]{0,63}$",
      "description": "Field to sort by, e.g. created_at; prefix with - for descending, e.g. -last_modified."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Rows per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "start": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Row offset to start from (default 0). Pass the previous reply's next_start."
    },
    "filters": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "field",
          "operator",
          "value"
        ],
        "properties": {
          "field": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]{0,63}$",
            "description": "Field name, e.g. first_name, title, status."
          },
          "value": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              }
            ],
            "description": "Value to compare with."
          },
          "operator": {
            "enum": [
              "eq",
              "gt",
              "gte",
              "lt",
              "lte",
              "contains"
            ],
            "type": "string",
            "description": "eq, gt, gte, lt, lte or contains."
          }
        }
      },
      "maxItems": 10,
      "minItems": 1,
      "description": "Conditions, all of which must match (AND). Dates are yyyy-mm-dd."
    }
  }
}

cogmento_list_tasks

List or search tasks (title, due date, completion date, assigned users, linked deal/contact/case). Filter e.g. on due_date. GET /tasks/.

read-only

Argument	Type	Description
sort	string	Field to sort by, e.g. created_at; prefix with - for descending, e.g. -last_modified.
limit	integer	Rows per page, 1-100 (default 25).
start	integer	Row offset to start from (default 0). Pass the previous reply's next_start.
filters	array	Conditions, all of which must match (AND). Dates are yyyy-mm-dd.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "properties": {
    "sort": {
      "type": "string",
      "pattern": "^-?[a-z][a-z0-9_]{0,63}$",
      "description": "Field to sort by, e.g. created_at; prefix with - for descending, e.g. -last_modified."
    },
    "limit": {
      "type": "integer",
      "maximum": 100,
      "description": "Rows per page, 1-100 (default 25).",
      "exclusiveMinimum": 0
    },
    "start": {
      "type": "integer",
      "maximum": 1000000,
      "minimum": 0,
      "description": "Row offset to start from (default 0). Pass the previous reply's next_start."
    },
    "filters": {
      "type": "array",
      "items": {
        "type": "object",
        "required": [
          "field",
          "operator",
          "value"
        ],
        "properties": {
          "field": {
            "type": "string",
            "pattern": "^[a-z][a-z0-9_]{0,63}$",
            "description": "Field name, e.g. first_name, title, status."
          },
          "value": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              },
              {
                "type": "boolean"
              }
            ],
            "description": "Value to compare with."
          },
          "operator": {
            "enum": [
              "eq",
              "gt",
              "gte",
              "lt",
              "lte",
              "contains"
            ],
            "type": "string",
            "description": "eq, gt, gte, lt, lte or contains."
          }
        }
      },
      "maxItems": 10,
      "minItems": 1,
      "description": "Conditions, all of which must match (AND). Dates are yyyy-mm-dd."
    }
  }
}

cogmento_set_deal_contact_stage

WRITE: record where a contact sits in a deal (a stage from cogmento_list_deal_stages). The contact is attached to the deal if it is not already. POST /deals/{id}/contact/{id}/stage/.

destructive

Argument	Type	Description
stage*	string	A stage name from cogmento_list_deal_stages.
deal_id*	string	Record id (UUID).
contact_id*	string	Record id (UUID).

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "deal_id",
    "contact_id",
    "stage"
  ],
  "properties": {
    "stage": {
      "type": "string",
      "maxLength": 200,
      "minLength": 1,
      "description": "A stage name from cogmento_list_deal_stages."
    },
    "deal_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Record id (UUID)."
    },
    "contact_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Record id (UUID)."
    }
  }
}

cogmento_update_record_field

WRITE: change a single field of a contact, company, deal, task or case, e.g. a deal's status or a contact's first_name. Custom field names come from cogmento_get_templates. System fields (id, acl, private, timestamps) are refused. PATCH /<type>/{id}/.

destructive

Argument	Type	Description
value*	any	The new value (type must match the field; dates yyyy-mm-dd; null clears a field).
record_id*	string	Record id (UUID).
field_name*	string	Field to set, e.g. first_name, title, status, amount, due_date.
record_type*	string	contact, company, deal, task or case.

Input schema (JSON)

{
  "type": "object",
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "required": [
    "record_type",
    "record_id",
    "field_name",
    "value"
  ],
  "properties": {
    "value": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 5000
        },
        {
          "type": "number"
        },
        {
          "type": "boolean"
        },
        {
          "type": "null"
        },
        {
          "type": "array",
          "items": {
            "anyOf": [
              {
                "type": "string",
                "maxLength": 500
              },
              {
                "type": "number"
              }
            ]
          },
          "maxItems": 100
        }
      ],
      "description": "The new value (type must match the field; dates yyyy-mm-dd; null clears a field)."
    },
    "record_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$",
      "description": "Record id (UUID)."
    },
    "field_name": {
      "type": "string",
      "pattern": "^[a-z][a-z0-9_]{0,63}$",
      "description": "Field to set, e.g. first_name, title, status, amount, due_date."
    },
    "record_type": {
      "enum": [
        "contact",
        "company",
        "deal",
        "task",
        "case"
      ],
      "type": "string",
      "description": "contact, company, deal, task or case."
    }
  }
}