Read and write Copper CRM people, companies, opportunities and activities.
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.
Create a new company. Copper REST: POST /companies.
The company name (required).
Tags to apply.
Freeform description / notes.
User id to own this company.
The company's email domain, e.g. example.com.
Phone numbers for the company.
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.
Create a new company. Copper REST: POST /companies.
| Argument | Type | Description |
|---|---|---|
| name* | string | The company name (required). |
| tags | array | Tags to apply. |
| details | string | Freeform description / notes. |
| assignee_id | integer | User id to own this company. |
| email_domain | string | The company's email domain, e.g. example.com. |
| phone_numbers | array | Phone numbers for the company. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The company name (required)."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to apply."
},
"details": {
"type": "string",
"description": "Freeform description / notes."
},
"assignee_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "User id to own this company."
},
"email_domain": {
"type": "string",
"description": "The company's email domain, e.g. example.com."
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"required": [
"number"
],
"properties": {
"number": {
"type": "string",
"description": "Phone number."
},
"category": {
"type": "string",
"description": "Category label, e.g. 'work', 'mobile', 'home'."
}
},
"description": "A phone-number entry."
},
"description": "Phone numbers for the company."
}
}
}Create a new lead. Copper REST: POST /leads.
| Argument | Type | Description |
|---|---|---|
| name* | string | The lead's name (required). |
| tags | array | Tags to apply. |
| object | The lead's email. | |
| title | string | Job title. |
| details | string | Freeform description / notes. |
| assignee_id | integer | User id to own this lead. |
| company_name | string | Company name the lead is associated with. |
| phone_numbers | array | Phone numbers for the lead. |
| monetary_value | number | Estimated value of the lead. |
| customer_source_id | integer | Id of the customer source. |
Create a new opportunity (deal). `name` and `primary_contact_id` are required by Copper. Copper REST: POST /opportunities.
| Argument | Type | Description |
|---|---|---|
| name* | string | The opportunity name (required). |
| tags | array | Tags to apply. |
| details | string | Freeform description / notes. |
| close_date | string | Expected close date, formatted MM/DD/YYYY. |
| company_id | integer | Id of the associated company. |
| assignee_id | integer | User id to own this opportunity. |
| pipeline_id | integer | Id of the pipeline to place the opportunity in. |
| monetary_value | number | Deal value (in the account's currency). |
| pipeline_stage_id | integer | Id of the pipeline stage. |
Create a new person (contact). Copper REST: POST /people.
| Argument | Type | Description |
|---|---|---|
| name* | string | The person's full name (required). |
| tags | array | Tags to apply. |
| title | string | Job title. |
| emails | array | Email addresses for the person. |
| details | string | Freeform description / notes. |
| company_id | integer | Id of the company this person works at. |
| assignee_id | integer | User id to own this person. |
| company_name | string | Company name (if not linking by company_id). |
| phone_numbers | array | Phone numbers for the person. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The person's full name (required)."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to apply."
},
"title": {
"type": "string",
"description": "Job title."
},
"emails": {
"type": "array",
"items": {
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"description": "Email address."
},
"category": {
"type": "string",
"description": "Category label, e.g. 'work' or 'home' (default 'work')."
}
},
"description": "An email entry."
},
"description": "Email addresses for the person."
},
"details": {
"type": "string",
"description": "Freeform description / notes."
},
"company_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Id of the company this person works at."
},
"assignee_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "User id to own this person."
},
"company_name": {
"type": "string",
"description": "Company name (if not linking by company_id)."
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"required": [
"number"
],
"properties": {
"number": {
"type": "string",
"description": "Phone number."
},
"category": {
"type": "string",
"description": "Category label, e.g. 'work', 'mobile', 'home'."
}
},
"description": "A phone-number entry."
},
"description": "Phone numbers for the person."
}
}
}Create a new task. Copper REST: POST /tasks.
| Argument | Type | Description |
|---|---|---|
| name* | string | The task name (required). |
| tags | array | Tags to apply. |
| details | string | Freeform description / notes. |
| due_date | integer | Due date as a Unix timestamp (seconds). |
| priority | string | Task priority. |
| assignee_id | integer | User id to own this task. |
| reminder_date | integer | Reminder date as a Unix timestamp (seconds). |
| related_resource_id | integer | Id of the record to attach the task to (requires related_resource_type). |
| related_resource_type | string | Type of record to attach the task to (requires related_resource_id). |
Get details of the authenticated Copper account. Copper REST: GET /account.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}Get a single company by id. Copper REST: GET /companies/{id}.
| Argument | Type | Description |
|---|---|---|
| id* | integer | The company id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The company id."
}
}
}Get a single lead by id. Copper REST: GET /leads/{id}.
| Argument | Type | Description |
|---|---|---|
| id* | integer | The lead id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The lead id."
}
}
}Get a single opportunity (deal) by id. Copper REST: GET /opportunities/{id}.
| Argument | Type | Description |
|---|---|---|
| id* | integer | The opportunity id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The opportunity id."
}
}
}Get a single person (contact) by id. Copper REST: GET /people/{id}.
| Argument | Type | Description |
|---|---|---|
| id* | integer | The person id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The person id."
}
}
}Get a single task by id. Copper REST: GET /tasks/{id}.
| Argument | Type | Description |
|---|---|---|
| id* | integer | The task id. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The task id."
}
}
}List activities (notes, calls, meetings, system events) attached to a record. Copper REST: POST /activities/search.
| Argument | Type | Description |
|---|---|---|
| page_size | integer | Results per page (default 20, max 200). |
| parent_id | integer | The id of the parent record to list activities for (requires parent_type). |
| page_number | integer | 1-based page number to fetch (default 1). |
| parent_type | string | Restrict to activities on a single record of this type (requires parent_id). |
| maximum_activity_date | integer | Latest activity date, as a Unix timestamp (seconds). |
| minimum_activity_date | integer | Earliest activity date, as a Unix timestamp (seconds). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page_size": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Results per page (default 20, max 200)."
},
"parent_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The id of the parent record to list activities for (requires parent_type)."
},
"page_number": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "1-based page number to fetch (default 1)."
},
"parent_type": {
"enum": [
"lead",
"person",
"company",
"opportunity",
"project",
"task"
],
"type": "string",
"description": "Restrict to activities on a single record of this type (requires parent_id)."
},
"maximum_activity_date": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Latest activity date, as a Unix timestamp (seconds)."
},
"minimum_activity_date": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Earliest activity date, as a Unix timestamp (seconds)."
}
}
}List the account's activity types (user + system), needed to log an activity. Copper REST: GET /activity_types.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}List sales pipelines and their stages (ids needed to place opportunities). Copper REST: GET /pipelines.
No arguments.
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {}
}List users in the Copper account (id, name, email) — useful for resolving assignee ids. Copper REST: POST /users/search.
| Argument | Type | Description |
|---|---|---|
| page_size | integer | Results per page (default 20, max 200). |
| page_number | integer | 1-based page number to fetch (default 1). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"page_size": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Results per page (default 20, max 200)."
},
"page_number": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "1-based page number to fetch (default 1)."
}
}
}Log a user activity (e.g. a note or call) on a record. Get the activity_type_id from copper_list_activity_types. Copper REST: POST /activities.
| Argument | Type | Description |
|---|---|---|
| details* | string | The activity note / description text. |
| parent_id* | integer | The id of the record to attach the activity to. |
| parent_type* | string | The kind of record to attach the activity to. |
| activity_date | integer | When the activity occurred, as a Unix timestamp (seconds). Defaults to now. |
| activity_type_id* | integer | Id of a 'user' activity type (from copper_list_activity_types). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"parent_type",
"parent_id",
"activity_type_id",
"details"
],
"properties": {
"details": {
"type": "string",
"description": "The activity note / description text."
},
"parent_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The id of the record to attach the activity to."
},
"parent_type": {
"enum": [
"lead",
"person",
"company",
"opportunity",
"project",
"task"
],
"type": "string",
"description": "The kind of record to attach the activity to."
},
"activity_date": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "When the activity occurred, as a Unix timestamp (seconds). Defaults to now."
},
"activity_type_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Id of a 'user' activity type (from copper_list_activity_types)."
}
}
}Search/list companies. All filters optional; returns a page of companies. Copper REST: POST /companies/search.
| Argument | Type | Description |
|---|---|---|
| city | string | City filter. |
| name | string | Company-name filter (substring match). |
| tags | array | Filter to companies carrying any of these tags. |
| state | string | State/region filter. |
| country | string | Country filter. |
| sort_by | string | Field to sort by, e.g. 'name', 'date_created' (default 'name'). |
| page_size | integer | Results per page (default 20, max 200). |
| page_number | integer | 1-based page number to fetch (default 1). |
| assignee_ids | array | Filter to companies owned by these user ids. |
| sort_direction |
Search/list leads. All filters optional; returns a page of leads. Copper REST: POST /leads/search.
| Argument | Type | Description |
|---|---|---|
| city | string | City filter. |
| name | string | Lead-name filter (substring match). |
| tags | array | Filter to leads carrying any of these tags. |
| state | string | State/region filter. |
| emails | array | Filter to leads with any of these email addresses. |
| country | string | Country filter. |
| sort_by | string | Field to sort by, e.g. 'name', 'date_created' (default 'name'). |
| page_size | integer | Results per page (default 20, max 200). |
| page_number | integer | 1-based page number to fetch (default 1). |
| assignee_ids | array |
Search/list opportunities (deals). All filters optional; returns a page of opportunities. Copper REST: POST /opportunities/search.
| Argument | Type | Description |
|---|---|---|
| name | string | Opportunity-name filter (substring match). |
| tags | array | Filter to opportunities carrying any of these tags. |
| sort_by | string | Field to sort by, e.g. 'name', 'date_created', 'monetary_value' (default 'name'). |
| page_size | integer | Results per page (default 20, max 200). |
| status_ids | array | Filter by status id: 0=Open, 1=Won, 2=Lost, 3=Abandoned. |
| company_ids | array | Filter to opportunities at these company ids. |
| page_number | integer | 1-based page number to fetch (default 1). |
| assignee_ids | array | Filter to opportunities owned by these user ids. |
| pipeline_ids | array |
Search/list people (contacts). All filters optional; returns a page of people. Copper REST: POST /people/search.
| Argument | Type | Description |
|---|---|---|
| city | string | City filter. |
| name | string | Full-name filter (substring match). |
| tags | array | Filter to people carrying any of these tags. |
| state | string | State/region filter. |
| emails | array | Filter to people with any of these email addresses. |
| country | string | Country filter. |
| sort_by | string | Field to sort by, e.g. 'name', 'date_created', 'date_modified' (default 'first_name'). |
| page_size | integer | Results per page (default 20, max 200). |
| company_ids | array | Filter to people at these company ids. |
| page_number |
Search/list tasks. All filters optional; returns a page of tasks. Copper REST: POST /tasks/search.
| Argument | Type | Description |
|---|---|---|
| name | string | Task-name filter (substring match). |
| status | string | Filter by task status. |
| sort_by | string | Field to sort by, e.g. 'name', 'due_date', 'date_created' (default 'name'). |
| page_size | integer | Results per page (default 20, max 200). |
| page_number | integer | 1-based page number to fetch (default 1). |
| assignee_ids | array | Filter to tasks owned by these user ids. |
| sort_direction | string | Sort direction — 'asc' or 'desc' (default asc). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"description": "Task-name filter (substring match)."
},
"status": {
"enum": [
"Open",
"Completed"
],
"type": "string",
"description": "Filter by task status."
},
"sort_by": {
"type": "string",
"description": "Field to sort by, e.g. 'name', 'due_date', 'date_created' (default 'name')."
},
"page_size": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Results per page (default 20, max 200)."
},
"page_number": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "1-based page number to fetch (default 1)."
},
"assignee_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"description": "Filter to tasks owned by these user ids."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction — 'asc' or 'desc' (default asc)."
}
}
}Update fields on an existing person. Only provided fields are changed. Copper REST: PUT /people/{id}.
| Argument | Type | Description |
|---|---|---|
| id* | integer | The person id to update. |
| name | string | The person's full name. |
| tags | array | Replace the person's tags. |
| title | string | Job title. |
| emails | array | Replace the person's email addresses. |
| details | string | Freeform description / notes. |
| company_id | integer | Id of the company this person works at. |
| assignee_id | integer | User id to own this person. |
| phone_numbers | array | Replace the person's phone numbers. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"id"
],
"properties": {
"id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "The person id to update."
},
"name": {
"type": "string",
"description": "The person's full name."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Replace the person's tags."
},
"title": {
"type": "string",
"description": "Job title."
},
"emails": {
"type": "array",
"items": {
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"description": "Email address."
},
"category": {
"type": "string",
"description": "Category label, e.g. 'work' or 'home' (default 'work')."
}
},
"description": "An email entry."
},
"description": "Replace the person's email addresses."
},
"details": {
"type": "string",
"description": "Freeform description / notes."
},
"company_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Id of the company this person works at."
},
"assignee_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "User id to own this person."
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"required": [
"number"
],
"properties": {
"number": {
"type": "string",
"description": "Phone number."
},
"category": {
"type": "string",
"description": "Category label, e.g. 'work', 'mobile', 'home'."
}
},
"description": "A phone-number entry."
},
"description": "Replace the person's phone numbers."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The lead's name (required)."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to apply."
},
"email": {
"type": "object",
"required": [
"email"
],
"properties": {
"email": {
"type": "string",
"description": "Email address."
},
"category": {
"type": "string",
"description": "Category label, e.g. 'work' or 'home' (default 'work')."
}
},
"description": "The lead's email."
},
"title": {
"type": "string",
"description": "Job title."
},
"details": {
"type": "string",
"description": "Freeform description / notes."
},
"assignee_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "User id to own this lead."
},
"company_name": {
"type": "string",
"description": "Company name the lead is associated with."
},
"phone_numbers": {
"type": "array",
"items": {
"type": "object",
"required": [
"number"
],
"properties": {
"number": {
"type": "string",
"description": "Phone number."
},
"category": {
"type": "string",
"description": "Category label, e.g. 'work', 'mobile', 'home'."
}
},
"description": "A phone-number entry."
},
"description": "Phone numbers for the lead."
},
"monetary_value": {
"type": "number",
"description": "Estimated value of the lead."
},
"customer_source_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Id of the customer source."
}
}
}| primary_contact_id* |
| integer |
| Id of the primary contact (person) for this opportunity (required by Copper). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name",
"primary_contact_id"
],
"properties": {
"name": {
"type": "string",
"description": "The opportunity name (required)."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to apply."
},
"details": {
"type": "string",
"description": "Freeform description / notes."
},
"close_date": {
"type": "string",
"description": "Expected close date, formatted MM/DD/YYYY."
},
"company_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Id of the associated company."
},
"assignee_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "User id to own this opportunity."
},
"pipeline_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Id of the pipeline to place the opportunity in."
},
"monetary_value": {
"type": "number",
"description": "Deal value (in the account's currency)."
},
"pipeline_stage_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Id of the pipeline stage."
},
"primary_contact_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Id of the primary contact (person) for this opportunity (required by Copper)."
}
}
}{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"required": [
"name"
],
"properties": {
"name": {
"type": "string",
"description": "The task name (required)."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Tags to apply."
},
"details": {
"type": "string",
"description": "Freeform description / notes."
},
"due_date": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Due date as a Unix timestamp (seconds)."
},
"priority": {
"enum": [
"None",
"High"
],
"type": "string",
"description": "Task priority."
},
"assignee_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "User id to own this task."
},
"reminder_date": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Reminder date as a Unix timestamp (seconds)."
},
"related_resource_id": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991,
"description": "Id of the record to attach the task to (requires related_resource_type)."
},
"related_resource_type": {
"enum": [
"lead",
"person",
"company",
"opportunity",
"project",
"task"
],
"type": "string",
"description": "Type of record to attach the task to (requires related_resource_id)."
}
}
}| string |
| Sort direction — 'asc' or 'desc' (default asc). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"city": {
"type": "string",
"description": "City filter."
},
"name": {
"type": "string",
"description": "Company-name filter (substring match)."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter to companies carrying any of these tags."
},
"state": {
"type": "string",
"description": "State/region filter."
},
"country": {
"type": "string",
"description": "Country filter."
},
"sort_by": {
"type": "string",
"description": "Field to sort by, e.g. 'name', 'date_created' (default 'name')."
},
"page_size": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Results per page (default 20, max 200)."
},
"page_number": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "1-based page number to fetch (default 1)."
},
"assignee_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"description": "Filter to companies owned by these user ids."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction — 'asc' or 'desc' (default asc)."
}
}
}| Filter to leads owned by these user ids. |
| sort_direction | string | Sort direction — 'asc' or 'desc' (default asc). |
| customer_source_ids | array | Filter by customer-source ids. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"city": {
"type": "string",
"description": "City filter."
},
"name": {
"type": "string",
"description": "Lead-name filter (substring match)."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter to leads carrying any of these tags."
},
"state": {
"type": "string",
"description": "State/region filter."
},
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter to leads with any of these email addresses."
},
"country": {
"type": "string",
"description": "Country filter."
},
"sort_by": {
"type": "string",
"description": "Field to sort by, e.g. 'name', 'date_created' (default 'name')."
},
"page_size": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Results per page (default 20, max 200)."
},
"page_number": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "1-based page number to fetch (default 1)."
},
"assignee_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"description": "Filter to leads owned by these user ids."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction — 'asc' or 'desc' (default asc)."
},
"customer_source_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"description": "Filter by customer-source ids."
}
}
}| Filter to opportunities in these pipelines. |
| sort_direction | string | Sort direction — 'asc' or 'desc' (default asc). |
| pipeline_stage_ids | array | Filter to opportunities at these pipeline stages. |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"name": {
"type": "string",
"description": "Opportunity-name filter (substring match)."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter to opportunities carrying any of these tags."
},
"sort_by": {
"type": "string",
"description": "Field to sort by, e.g. 'name', 'date_created', 'monetary_value' (default 'name')."
},
"page_size": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Results per page (default 20, max 200)."
},
"status_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"description": "Filter by status id: 0=Open, 1=Won, 2=Lost, 3=Abandoned."
},
"company_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"description": "Filter to opportunities at these company ids."
},
"page_number": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "1-based page number to fetch (default 1)."
},
"assignee_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"description": "Filter to opportunities owned by these user ids."
},
"pipeline_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"description": "Filter to opportunities in these pipelines."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction — 'asc' or 'desc' (default asc)."
},
"pipeline_stage_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"description": "Filter to opportunities at these pipeline stages."
}
}
}| integer |
| 1-based page number to fetch (default 1). |
| assignee_ids | array | Filter to people owned by these user ids. |
| phone_number | string | Phone-number filter. |
| sort_direction | string | Sort direction — 'asc' or 'desc' (default asc). |
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"city": {
"type": "string",
"description": "City filter."
},
"name": {
"type": "string",
"description": "Full-name filter (substring match)."
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter to people carrying any of these tags."
},
"state": {
"type": "string",
"description": "State/region filter."
},
"emails": {
"type": "array",
"items": {
"type": "string"
},
"description": "Filter to people with any of these email addresses."
},
"country": {
"type": "string",
"description": "Country filter."
},
"sort_by": {
"type": "string",
"description": "Field to sort by, e.g. 'name', 'date_created', 'date_modified' (default 'first_name')."
},
"page_size": {
"type": "integer",
"maximum": 200,
"minimum": 1,
"description": "Results per page (default 20, max 200)."
},
"company_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"description": "Filter to people at these company ids."
},
"page_number": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": 1,
"description": "1-based page number to fetch (default 1)."
},
"assignee_ids": {
"type": "array",
"items": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
},
"description": "Filter to people owned by these user ids."
},
"phone_number": {
"type": "string",
"description": "Phone-number filter."
},
"sort_direction": {
"enum": [
"asc",
"desc"
],
"type": "string",
"description": "Sort direction — 'asc' or 'desc' (default asc)."
}
}
}