> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # centralstationcrm-deals-projects > CentralStationCRM Deals & Projects — manage deals, projects, and related protocols **Server path:** `/centralstationcrm-deals-projects` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | | [`centralstationcrm_deals_projects_delete_api_deals_by_id`](#centralstationcrm_deals_projects_delete_api_deals_by_id) | Destroy a deal | | [`centralstationcrm_deals_projects_delete_api_projects_by_id`](#centralstationcrm_deals_projects_delete_api_projects_by_id) | Destroy a project | | [`centralstationcrm_deals_projects_get_api_deals`](#centralstationcrm_deals_projects_get_api_deals) | Retrieves all deals | | [`centralstationcrm_deals_projects_get_api_deals_by_deal_id_external_emails`](#centralstationcrm_deals_projects_get_api_deals_by_deal_id_external_emails) | Retrieves all external\_emails | | [`centralstationcrm_deals_projects_get_api_deals_by_deal_id_external_emails_count`](#centralstationcrm_deals_projects_get_api_deals_by_deal_id_external_emails_count) | Retrieves total amount of external\_emails | | [`centralstationcrm_deals_projects_get_api_deals_by_deal_id_maildrop`](#centralstationcrm_deals_projects_get_api_deals_by_deal_id_maildrop) | Retrieves the maildrop | | [`centralstationcrm_deals_projects_get_api_deals_by_id`](#centralstationcrm_deals_projects_get_api_deals_by_id) | Retrieves a deal | | [`centralstationcrm_deals_projects_get_api_deals_count`](#centralstationcrm_deals_projects_get_api_deals_count) | Retrieves total amount of deals | | [`centralstationcrm_deals_projects_get_api_deals_search`](#centralstationcrm_deals_projects_get_api_deals_search) | Retrieves deals matching the search | | [`centralstationcrm_deals_projects_get_api_deals_stats`](#centralstationcrm_deals_projects_get_api_deals_stats) | Retrieves key information of deals | | [`centralstationcrm_deals_projects_get_api_projects`](#centralstationcrm_deals_projects_get_api_projects) | Retrieves all projects | | [`centralstationcrm_deals_projects_get_api_projects_by_id`](#centralstationcrm_deals_projects_get_api_projects_by_id) | Retrieves a project | | [`centralstationcrm_deals_projects_get_api_projects_by_project_id_external_emails`](#centralstationcrm_deals_projects_get_api_projects_by_project_id_external_emails) | Retrieves all external\_emails | | [`centralstationcrm_deals_projects_get_api_projects_by_project_id_external_emails_count`](#centralstationcrm_deals_projects_get_api_projects_by_project_id_external_emails_count) | Retrieves total amount of external\_emails | | [`centralstationcrm_deals_projects_get_api_projects_by_project_id_maildrop`](#centralstationcrm_deals_projects_get_api_projects_by_project_id_maildrop) | Retrieves the maildrop | | [`centralstationcrm_deals_projects_get_api_projects_count`](#centralstationcrm_deals_projects_get_api_projects_count) | Retrieves total amount of projects | | [`centralstationcrm_deals_projects_get_api_projects_search`](#centralstationcrm_deals_projects_get_api_projects_search) | Retrieves projects matching the search | | [`centralstationcrm_deals_projects_get_api_projects_stats`](#centralstationcrm_deals_projects_get_api_projects_stats) | Retrieves key information of projects | | [`centralstationcrm_deals_projects_post_api_deals`](#centralstationcrm_deals_projects_post_api_deals) | Creates a basic deal | | [`centralstationcrm_deals_projects_post_api_projects`](#centralstationcrm_deals_projects_post_api_projects) | Creates a basic project | | [`centralstationcrm_deals_projects_put_api_deals_by_id`](#centralstationcrm_deals_projects_put_api_deals_by_id) | Update a deal | | [`centralstationcrm_deals_projects_put_api_projects_by_id`](#centralstationcrm_deals_projects_put_api_projects_by_id) | Update a project | *** ## centralstationcrm\_deals\_projects\_delete\_api\_deals\_by\_id Destroy a deal **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------------------------------------------------------------- | | `id` | string | Yes | — | The id value | | `no_log` | boolean | No | — | Set to true if you don't want to generate a activity for the stream. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "no_log": { "type": "boolean", "description": "Set to true if you don't want to generate a activity for the stream." } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_deals\_projects\_delete\_api\_projects\_by\_id Destroy a project **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------------------------------------------------------------- | | `id` | string | Yes | — | The id value | | `no_log` | boolean | No | — | Set to true if you don't want to generate a activity for the stream. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "no_log": { "type": "boolean", "description": "Set to true if you don't want to generate a activity for the stream." } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_deals\_projects\_get\_api\_deals Retrieves all deals **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `perpage` | integer | No | — | Elements per page, maximum of 250 | | `page` | integer | No | — | Retrieve records of the given page | | `order` | string | No | — | Ordering of records using one of the following order options: `date-asc`, `date-desc`, `new-asc`, `new-desc`, `update-asc`, `update-desc`, `value-asc`, `value-desc`, `state-asc`, `state-desc`, `abc-asc`, `abc-desc` | | `includes` | string | No | — | possible includes are: tags, people, company, task\_lists, tasks, pending\_tasks, cal\_events, upcoming\_cal\_events, custom\_fields separated by space. Receive all includes using the 'all' value. | | `methods` | string | No | — | Possible methods are: responsible\_user\_natural\_name, people\_ids, absolute\_url, stream\_updated\_at separated by space. Receive all methods using the 'all' value. | | `tag_id` | integer | No | — | Optionally submit a tag ID in order to only see deals tagged with the submitted tag | | `tag_name` | string | No | — | Optionally submit a tag name in order to only see deals tagged with the submitted tag | | `stream_updated_at_before` | string | No | — | Optionally submit a date or timestamp (ISO 8601) in order to only see deals with activities within the stream earlier than the submitted point in time. | | `stream_updated_at_after` | string | No | — | Optionally submit a date or timestamp (ISO 8601) in order to only see deals with activities within the stream later than the submitted point in time. | | `filter` | object | No | — | Optionally submit one of the deals attributes in order to filter by them (e.g. \{ 'user\_id': \{ 'equal': 'your-value' } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller\_than, larger\_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "perpage": { "type": "integer", "description": "Elements per page, maximum of 250" }, "page": { "type": "integer", "description": "Retrieve records of the given page" }, "order": { "type": "string", "description": "Ordering of records using one of the following order options: `date-asc`, `date-desc`, `new-asc`, `new-desc`, `update-asc`, `update-desc`, `value-asc`, `value-desc`, `state-asc`, `state-desc`, `abc-asc`, `abc-desc`" }, "includes": { "type": "string", "description": "possible includes are: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields separated by space. Receive all includes using the 'all' value." }, "methods": { "type": "string", "description": "Possible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the 'all' value." }, "tag_id": { "type": "integer", "description": "Optionally submit a tag ID in order to only see deals tagged with the submitted tag" }, "tag_name": { "type": "string", "description": "Optionally submit a tag name in order to only see deals tagged with the submitted tag" }, "stream_updated_at_before": { "type": "string", "description": "Optionally submit a date or timestamp (ISO 8601) in order to only see deals with activities within the stream earlier than the submitted point in time." }, "stream_updated_at_after": { "type": "string", "description": "Optionally submit a date or timestamp (ISO 8601) in order to only see deals with activities within the stream later than the submitted point in time." }, "filter": { "type": "object", "description": "Optionally submit one of the deals attributes in order to filter by them (e.g. { 'user_id': { 'equal': 'your-value' } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`)." } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_deals\_projects\_get\_api\_deals\_by\_deal\_id\_external\_emails Retrieves all external\_emails **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | --------------------------------------------------------------------------------- | | `order` | string | No | — | Ordering of records using one of the following order options: `id-asc`, `id-desc` | | `perpage` | integer | No | — | Elements per page, maximum of 250 | | `page` | integer | No | — | Retrieve records of the given page | | `includes` | string | No | — | possible option: comments | | `deal_id` | integer | Yes | — | ID of the external\_emails of the desired deal | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order": { "type": "string", "description": "Ordering of records using one of the following order options: `id-asc`, `id-desc`" }, "perpage": { "type": "integer", "description": "Elements per page, maximum of 250" }, "page": { "type": "integer", "description": "Retrieve records of the given page" }, "includes": { "type": "string", "description": "possible option: comments" }, "deal_id": { "type": "integer", "description": "ID of the external_emails of the desired deal" } }, "required": [ "PCID", "deal_id" ] } ``` *** ## centralstationcrm\_deals\_projects\_get\_api\_deals\_by\_deal\_id\_external\_emails\_count Retrieves total amount of external\_emails **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ---------------------------------------------- | | `deal_id` | integer | Yes | — | ID of the external\_emails of the desired deal | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "deal_id": { "type": "integer", "description": "ID of the external_emails of the desired deal" } }, "required": [ "PCID", "deal_id" ] } ``` *** ## centralstationcrm\_deals\_projects\_get\_api\_deals\_by\_deal\_id\_maildrop Retrieves the maildrop **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------------------------------- | | `deal_id` | integer | Yes | — | ID of the deal the maildrop belong to | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "deal_id": { "type": "integer", "description": "ID of the deal the maildrop belong to" } }, "required": [ "PCID", "deal_id" ] } ``` *** ## centralstationcrm\_deals\_projects\_get\_api\_deals\_by\_id Retrieves a deal **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | integer | Yes | — | The id value | | `includes` | string | No | — | possible includes are: tags, people, company, task\_lists, tasks, pending\_tasks, cal\_events, upcoming\_cal\_events, custom\_fields separated by space. Receive all includes using the 'all' value. | | `methods` | string | No | — | Possible methods are: responsible\_user\_natural\_name, people\_ids, absolute\_url, stream\_updated\_at separated by space. Receive all methods using the 'all' value. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The id value" }, "includes": { "type": "string", "description": "possible includes are: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields separated by space. Receive all includes using the 'all' value." }, "methods": { "type": "string", "description": "Possible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the 'all' value." } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_deals\_projects\_get\_api\_deals\_count Retrieves total amount of deals **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `tag_id` | integer | No | — | Optionally submit a tag ID in order to only see deals tagged with the submitted tag | | `tag_name` | string | No | — | Optionally submit a tag name in order to only see deals tagged with the submitted tag | | `filter` | object | No | — | Optionally submit one of the deals attributes in order to filter by them (e.g. \{ 'user\_id': \{ 'equal': 'your-value' } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller\_than, larger\_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tag_id": { "type": "integer", "description": "Optionally submit a tag ID in order to only see deals tagged with the submitted tag" }, "tag_name": { "type": "string", "description": "Optionally submit a tag name in order to only see deals tagged with the submitted tag" }, "filter": { "type": "object", "description": "Optionally submit one of the deals attributes in order to filter by them (e.g. { 'user_id': { 'equal': 'your-value' } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`)." } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_deals\_projects\_get\_api\_deals\_search Retrieves deals matching the search **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `perpage` | integer | No | — | Elements per page, maximum of 250 | | `page` | integer | No | — | Retrieve records of the given page | | `name` | string | No | — | Retrieve deals by their name | | `includes` | string | No | — | possible includes are: tags, people, company, task\_lists, tasks, pending\_tasks, cal\_events, upcoming\_cal\_events, custom\_fields separated by space. Receive all includes using the 'all' value. | | `methods` | string | No | — | Possible methods are: responsible\_user\_natural\_name, people\_ids, absolute\_url, stream\_updated\_at separated by space. Receive all methods using the 'all' value. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "perpage": { "type": "integer", "description": "Elements per page, maximum of 250" }, "page": { "type": "integer", "description": "Retrieve records of the given page" }, "name": { "type": "string", "description": "Retrieve deals by their name" }, "includes": { "type": "string", "description": "possible includes are: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields separated by space. Receive all includes using the 'all' value." }, "methods": { "type": "string", "description": "Possible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the 'all' value." } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_deals\_projects\_get\_api\_deals\_stats Retrieves key information of deals **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `tag_id` | integer | No | — | Optionally submit a tag ID in order to only see deals tagged with the submitted tag | | `tag_name` | string | No | — | Optionally submit a tag name in order to only see deals tagged with the submitted tag | | `filter` | object | No | — | Optionally submit one of the deals attributes in order to filter by them (e.g. \{ 'user\_id': \{ 'equal': 'your-value' } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller\_than, larger\_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tag_id": { "type": "integer", "description": "Optionally submit a tag ID in order to only see deals tagged with the submitted tag" }, "tag_name": { "type": "string", "description": "Optionally submit a tag name in order to only see deals tagged with the submitted tag" }, "filter": { "type": "object", "description": "Optionally submit one of the deals attributes in order to filter by them (e.g. { 'user_id': { 'equal': 'your-value' } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`)." } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_deals\_projects\_get\_api\_projects Retrieves all projects **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `perpage` | integer | No | — | Elements per page, maximum of 250 | | `page` | integer | No | — | Retrieve records of the given page | | `order` | string | No | — | Ordering of records using one of the following order options: `date-asc`, `date-desc`, `new-asc`, `new-desc`, `update-asc`, `update-desc`, `state-asc`, `state-desc`, `abc-asc`, `abc-desc` | | `includes` | string | No | — | possible includes are: tags, people, company, task\_lists, tasks, pending\_tasks, cal\_events, upcoming\_cal\_events, custom\_fields separated by space. Receive all includes using the 'all' value. | | `methods` | string | No | — | Possible methods are: responsible\_user\_natural\_name, people\_ids, absolute\_url, stream\_updated\_at separated by space. Receive all methods using the 'all' value. | | `tag_id` | integer | No | — | Optionally submit a tag ID in order to only see projects tagged with the submitted tag | | `tag_name` | string | No | — | Optionally submit a tag name in order to only see projects tagged with the submitted tag | | `stream_updated_at_before` | string | No | — | Optionally submit a date or timestamp (ISO 8601) in order to only see projects with activities within the stream earlier than the submitted point in time. | | `stream_updated_at_after` | string | No | — | Optionally submit a date or timestamp (ISO 8601) in order to only see projects with activities within the stream later than the submitted point in time. | | `filter` | object | No | — | Optionally submit one of the projects attributes in order to filter by them (e.g. \{ 'user\_id': \{ 'equal': 'your-value' } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller\_than, larger\_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "perpage": { "type": "integer", "description": "Elements per page, maximum of 250" }, "page": { "type": "integer", "description": "Retrieve records of the given page" }, "order": { "type": "string", "description": "Ordering of records using one of the following order options: `date-asc`, `date-desc`, `new-asc`, `new-desc`, `update-asc`, `update-desc`, `state-asc`, `state-desc`, `abc-asc`, `abc-desc`" }, "includes": { "type": "string", "description": "possible includes are: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields separated by space. Receive all includes using the 'all' value." }, "methods": { "type": "string", "description": "Possible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the 'all' value." }, "tag_id": { "type": "integer", "description": "Optionally submit a tag ID in order to only see projects tagged with the submitted tag" }, "tag_name": { "type": "string", "description": "Optionally submit a tag name in order to only see projects tagged with the submitted tag" }, "stream_updated_at_before": { "type": "string", "description": "Optionally submit a date or timestamp (ISO 8601) in order to only see projects with activities within the stream earlier than the submitted point in time." }, "stream_updated_at_after": { "type": "string", "description": "Optionally submit a date or timestamp (ISO 8601) in order to only see projects with activities within the stream later than the submitted point in time." }, "filter": { "type": "object", "description": "Optionally submit one of the projects attributes in order to filter by them (e.g. { 'user_id': { 'equal': 'your-value' } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`)." } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_deals\_projects\_get\_api\_projects\_by\_id Retrieves a project **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | integer | Yes | — | The id value | | `includes` | string | No | — | possible includes are: tags, people, company, task\_lists, tasks, pending\_tasks, cal\_events, upcoming\_cal\_events, custom\_fields separated by space. Receive all includes using the 'all' value. | | `methods` | string | No | — | Possible methods are: responsible\_user\_natural\_name, people\_ids, absolute\_url, stream\_updated\_at separated by space. Receive all methods using the 'all' value. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The id value" }, "includes": { "type": "string", "description": "possible includes are: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields separated by space. Receive all includes using the 'all' value." }, "methods": { "type": "string", "description": "Possible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the 'all' value." } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_deals\_projects\_get\_api\_projects\_by\_project\_id\_external\_emails Retrieves all external\_emails **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | --------------------------------------------------------------------------------- | | `order` | string | No | — | Ordering of records using one of the following order options: `id-asc`, `id-desc` | | `perpage` | integer | No | — | Elements per page, maximum of 250 | | `page` | integer | No | — | Retrieve records of the given page | | `includes` | string | No | — | possible option: comments | | `project_id` | integer | Yes | — | ID of the external\_emails of the desired project | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order": { "type": "string", "description": "Ordering of records using one of the following order options: `id-asc`, `id-desc`" }, "perpage": { "type": "integer", "description": "Elements per page, maximum of 250" }, "page": { "type": "integer", "description": "Retrieve records of the given page" }, "includes": { "type": "string", "description": "possible option: comments" }, "project_id": { "type": "integer", "description": "ID of the external_emails of the desired project" } }, "required": [ "PCID", "project_id" ] } ``` *** ## centralstationcrm\_deals\_projects\_get\_api\_projects\_by\_project\_id\_external\_emails\_count Retrieves total amount of external\_emails **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ------------------------------------------------- | | `project_id` | integer | Yes | — | ID of the external\_emails of the desired project | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "integer", "description": "ID of the external_emails of the desired project" } }, "required": [ "PCID", "project_id" ] } ``` *** ## centralstationcrm\_deals\_projects\_get\_api\_projects\_by\_project\_id\_maildrop Retrieves the maildrop **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ---------------------------------------- | | `project_id` | integer | Yes | — | ID of the project the maildrop belong to | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "project_id": { "type": "integer", "description": "ID of the project the maildrop belong to" } }, "required": [ "PCID", "project_id" ] } ``` *** ## centralstationcrm\_deals\_projects\_get\_api\_projects\_count Retrieves total amount of projects **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `tag_id` | integer | No | — | Optionally submit a tag ID in order to only see projects tagged with the submitted tag | | `tag_name` | string | No | — | Optionally submit a tag name in order to only see projects tagged with the submitted tag | | `filter` | object | No | — | Optionally submit one of the projects attributes in order to filter by them (e.g. \{ 'user\_id': \{ 'equal': 'your-value' } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller\_than, larger\_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tag_id": { "type": "integer", "description": "Optionally submit a tag ID in order to only see projects tagged with the submitted tag" }, "tag_name": { "type": "string", "description": "Optionally submit a tag name in order to only see projects tagged with the submitted tag" }, "filter": { "type": "object", "description": "Optionally submit one of the projects attributes in order to filter by them (e.g. { 'user_id': { 'equal': 'your-value' } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`)." } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_deals\_projects\_get\_api\_projects\_search Retrieves projects matching the search **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `perpage` | integer | No | — | Elements per page, maximum of 250 | | `page` | integer | No | — | Retrieve records of the given page | | `name` | string | No | — | Retrieve projects by their name | | `includes` | string | No | — | possible includes are: tags, people, company, task\_lists, tasks, pending\_tasks, cal\_events, upcoming\_cal\_events, custom\_fields separated by space. Receive all includes using the 'all' value. | | `methods` | string | No | — | Possible methods are: responsible\_user\_natural\_name, people\_ids, absolute\_url, stream\_updated\_at separated by space. Receive all methods using the 'all' value. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "perpage": { "type": "integer", "description": "Elements per page, maximum of 250" }, "page": { "type": "integer", "description": "Retrieve records of the given page" }, "name": { "type": "string", "description": "Retrieve projects by their name" }, "includes": { "type": "string", "description": "possible includes are: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields separated by space. Receive all includes using the 'all' value." }, "methods": { "type": "string", "description": "Possible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the 'all' value." } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_deals\_projects\_get\_api\_projects\_stats Retrieves key information of projects **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `tag_id` | integer | No | — | Optionally submit a tag ID in order to only see projects tagged with the submitted tag | | `tag_name` | string | No | — | Optionally submit a tag name in order to only see projects tagged with the submitted tag | | `filter` | object | No | — | Optionally submit one of the projects attributes in order to filter by them (e.g. \{ 'user\_id': \{ 'equal': 'your-value' } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller\_than, larger\_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tag_id": { "type": "integer", "description": "Optionally submit a tag ID in order to only see projects tagged with the submitted tag" }, "tag_name": { "type": "string", "description": "Optionally submit a tag name in order to only see projects tagged with the submitted tag" }, "filter": { "type": "object", "description": "Optionally submit one of the projects attributes in order to filter by them (e.g. { 'user_id': { 'equal': 'your-value' } }). Allowed filter modifiers are `smaller_than`, `larger_than`, `equal`, `between` or `in`. Whereas smaller_than, larger_than and equal expect one value, between expects exactly two values comma separated (e.g. `{ 'between': '2023-01-01,2023-02-01' }`) and `in` allows a list of comma separated options (e.g. `{ 'in': '23,42,99' }`)." } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_deals\_projects\_post\_api\_deals Creates a basic deal **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `includes` | string | No | — | possible includes are: tags, people, company, task\_lists, tasks, pending\_tasks, cal\_events, upcoming\_cal\_events, custom\_fields separated by space. Receive all includes using the 'all' value. | | `methods` | string | No | — | Possible methods are: responsible\_user\_natural\_name, people\_ids, absolute\_url, stream\_updated\_at separated by space. Receive all methods using the 'all' value. | | `no_log` | boolean | No | — | Set to true if you don't want to generate a activity for the stream. | | `deal` | object | No | — | The deal value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "includes": { "type": "string", "description": "possible includes are: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields separated by space. Receive all includes using the 'all' value." }, "methods": { "type": "string", "description": "Possible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the 'all' value." }, "no_log": { "type": "boolean", "description": "Set to true if you don't want to generate a activity for the stream." }, "deal": { "description": "The deal value" } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_deals\_projects\_post\_api\_projects Creates a basic project **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `includes` | string | No | — | possible includes are: tags, people, company, task\_lists, tasks, pending\_tasks, cal\_events, upcoming\_cal\_events, custom\_fields separated by space. Receive all includes using the 'all' value. | | `methods` | string | No | — | Possible methods are: responsible\_user\_natural\_name, people\_ids, absolute\_url, stream\_updated\_at separated by space. Receive all methods using the 'all' value. | | `no_log` | boolean | No | — | Set to true if you don't want to generate a activity for the stream. | | `project` | object | No | — | The project value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "includes": { "type": "string", "description": "possible includes are: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields separated by space. Receive all includes using the 'all' value." }, "methods": { "type": "string", "description": "Possible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the 'all' value." }, "no_log": { "type": "boolean", "description": "Set to true if you don't want to generate a activity for the stream." }, "project": { "description": "The project value" } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_deals\_projects\_put\_api\_deals\_by\_id Update a deal **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------------------------------------------------------------- | | `id` | string | Yes | — | The id value | | `no_log` | boolean | No | — | Set to true if you don't want to generate a activity for the stream. | | `deal` | object | No | — | The deal value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "no_log": { "type": "boolean", "description": "Set to true if you don't want to generate a activity for the stream." }, "deal": { "description": "The deal value" } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_deals\_projects\_put\_api\_projects\_by\_id Update a project **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------------------------------------------------------------- | | `id` | string | Yes | — | The id value | | `no_log` | boolean | No | — | Set to true if you don't want to generate a activity for the stream. | | `project` | object | No | — | The project value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "no_log": { "type": "boolean", "description": "Set to true if you don't want to generate a activity for the stream." }, "project": { "description": "The project value" } }, "required": [ "PCID", "id" ] } ```