Skip to main content
Server path: /centralstationcrm-deals-projects | Type: Application | PCID required: Yes

Tools

ToolDescription
centralstationcrm_deals_projects_delete_api_deals_by_idDestroy a deal
centralstationcrm_deals_projects_delete_api_projects_by_idDestroy a project
centralstationcrm_deals_projects_get_api_dealsRetrieves all deals
centralstationcrm_deals_projects_get_api_deals_by_deal_id_external_emailsRetrieves all external_emails
centralstationcrm_deals_projects_get_api_deals_by_deal_id_external_emails_countRetrieves total amount of external_emails
centralstationcrm_deals_projects_get_api_deals_by_deal_id_maildropRetrieves the maildrop
centralstationcrm_deals_projects_get_api_deals_by_idRetrieves a deal
centralstationcrm_deals_projects_get_api_deals_countRetrieves total amount of deals
centralstationcrm_deals_projects_get_api_deals_searchRetrieves deals matching the search
centralstationcrm_deals_projects_get_api_deals_statsRetrieves key information of deals
centralstationcrm_deals_projects_get_api_projectsRetrieves all projects
centralstationcrm_deals_projects_get_api_projects_by_idRetrieves a project
centralstationcrm_deals_projects_get_api_projects_by_project_id_external_emailsRetrieves all external_emails
centralstationcrm_deals_projects_get_api_projects_by_project_id_external_emails_countRetrieves total amount of external_emails
centralstationcrm_deals_projects_get_api_projects_by_project_id_maildropRetrieves the maildrop
centralstationcrm_deals_projects_get_api_projects_countRetrieves total amount of projects
centralstationcrm_deals_projects_get_api_projects_searchRetrieves projects matching the search
centralstationcrm_deals_projects_get_api_projects_statsRetrieves key information of projects
centralstationcrm_deals_projects_post_api_dealsCreates a basic deal
centralstationcrm_deals_projects_post_api_projectsCreates a basic project
centralstationcrm_deals_projects_put_api_deals_by_idUpdate a deal
centralstationcrm_deals_projects_put_api_projects_by_idUpdate a project

centralstationcrm_deals_projects_delete_api_deals_by_id

Destroy a deal Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
no_logbooleanNoSet to true if you don’t want to generate a activity for the stream.

centralstationcrm_deals_projects_delete_api_projects_by_id

Destroy a project Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
no_logbooleanNoSet to true if you don’t want to generate a activity for the stream.

centralstationcrm_deals_projects_get_api_deals

Retrieves all deals Parameters:
ParameterTypeRequiredDefaultDescription
perpageintegerNoElements per page, maximum of 250
pageintegerNoRetrieve records of the given page
orderstringNoOrdering 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
includesstringNopossible 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.
methodsstringNoPossible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the ‘all’ value.
tag_idintegerNoOptionally submit a tag ID in order to only see deals tagged with the submitted tag
tag_namestringNoOptionally submit a tag name in order to only see deals tagged with the submitted tag
stream_updated_at_beforestringNoOptionally 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_afterstringNoOptionally 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.
filterobjectNoOptionally 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' }).

centralstationcrm_deals_projects_get_api_deals_by_deal_id_external_emails

Retrieves all external_emails Parameters:
ParameterTypeRequiredDefaultDescription
orderstringNoOrdering of records using one of the following order options: id-asc, id-desc
perpageintegerNoElements per page, maximum of 250
pageintegerNoRetrieve records of the given page
includesstringNopossible option: comments
deal_idintegerYesID of the external_emails of the desired deal

centralstationcrm_deals_projects_get_api_deals_by_deal_id_external_emails_count

Retrieves total amount of external_emails Parameters:
ParameterTypeRequiredDefaultDescription
deal_idintegerYesID of the external_emails of the desired deal

centralstationcrm_deals_projects_get_api_deals_by_deal_id_maildrop

Retrieves the maildrop Parameters:
ParameterTypeRequiredDefaultDescription
deal_idintegerYesID of the deal the maildrop belong to

centralstationcrm_deals_projects_get_api_deals_by_id

Retrieves a deal Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesid
includesstringNopossible 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.
methodsstringNoPossible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the ‘all’ value.

centralstationcrm_deals_projects_get_api_deals_count

Retrieves total amount of deals Parameters:
ParameterTypeRequiredDefaultDescription
tag_idintegerNoOptionally submit a tag ID in order to only see deals tagged with the submitted tag
tag_namestringNoOptionally submit a tag name in order to only see deals tagged with the submitted tag
filterobjectNoOptionally 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' }).

Retrieves deals matching the search Parameters:
ParameterTypeRequiredDefaultDescription
perpageintegerNoElements per page, maximum of 250
pageintegerNoRetrieve records of the given page
namestringNoRetrieve deals by their name
includesstringNopossible 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.
methodsstringNoPossible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the ‘all’ value.

centralstationcrm_deals_projects_get_api_deals_stats

Retrieves key information of deals Parameters:
ParameterTypeRequiredDefaultDescription
tag_idintegerNoOptionally submit a tag ID in order to only see deals tagged with the submitted tag
tag_namestringNoOptionally submit a tag name in order to only see deals tagged with the submitted tag
filterobjectNoOptionally 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' }).

centralstationcrm_deals_projects_get_api_projects

Retrieves all projects Parameters:
ParameterTypeRequiredDefaultDescription
perpageintegerNoElements per page, maximum of 250
pageintegerNoRetrieve records of the given page
orderstringNoOrdering 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
includesstringNopossible 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.
methodsstringNoPossible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the ‘all’ value.
tag_idintegerNoOptionally submit a tag ID in order to only see projects tagged with the submitted tag
tag_namestringNoOptionally submit a tag name in order to only see projects tagged with the submitted tag
stream_updated_at_beforestringNoOptionally 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_afterstringNoOptionally 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.
filterobjectNoOptionally 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' }).

centralstationcrm_deals_projects_get_api_projects_by_id

Retrieves a project Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesid
includesstringNopossible 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.
methodsstringNoPossible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the ‘all’ value.

centralstationcrm_deals_projects_get_api_projects_by_project_id_external_emails

Retrieves all external_emails Parameters:
ParameterTypeRequiredDefaultDescription
orderstringNoOrdering of records using one of the following order options: id-asc, id-desc
perpageintegerNoElements per page, maximum of 250
pageintegerNoRetrieve records of the given page
includesstringNopossible option: comments
project_idintegerYesID of the external_emails of the desired project

centralstationcrm_deals_projects_get_api_projects_by_project_id_external_emails_count

Retrieves total amount of external_emails Parameters:
ParameterTypeRequiredDefaultDescription
project_idintegerYesID of the external_emails of the desired project

centralstationcrm_deals_projects_get_api_projects_by_project_id_maildrop

Retrieves the maildrop Parameters:
ParameterTypeRequiredDefaultDescription
project_idintegerYesID of the project the maildrop belong to

centralstationcrm_deals_projects_get_api_projects_count

Retrieves total amount of projects Parameters:
ParameterTypeRequiredDefaultDescription
tag_idintegerNoOptionally submit a tag ID in order to only see projects tagged with the submitted tag
tag_namestringNoOptionally submit a tag name in order to only see projects tagged with the submitted tag
filterobjectNoOptionally 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' }).

Retrieves projects matching the search Parameters:
ParameterTypeRequiredDefaultDescription
perpageintegerNoElements per page, maximum of 250
pageintegerNoRetrieve records of the given page
namestringNoRetrieve projects by their name
includesstringNopossible 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.
methodsstringNoPossible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the ‘all’ value.

centralstationcrm_deals_projects_get_api_projects_stats

Retrieves key information of projects Parameters:
ParameterTypeRequiredDefaultDescription
tag_idintegerNoOptionally submit a tag ID in order to only see projects tagged with the submitted tag
tag_namestringNoOptionally submit a tag name in order to only see projects tagged with the submitted tag
filterobjectNoOptionally 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' }).

centralstationcrm_deals_projects_post_api_deals

Creates a basic deal Parameters:
ParameterTypeRequiredDefaultDescription
includesstringNopossible 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.
methodsstringNoPossible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the ‘all’ value.
no_logbooleanNoSet to true if you don’t want to generate a activity for the stream.
dealobjectNodeal

centralstationcrm_deals_projects_post_api_projects

Creates a basic project Parameters:
ParameterTypeRequiredDefaultDescription
includesstringNopossible 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.
methodsstringNoPossible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the ‘all’ value.
no_logbooleanNoSet to true if you don’t want to generate a activity for the stream.
projectobjectNoproject

centralstationcrm_deals_projects_put_api_deals_by_id

Update a deal Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
no_logbooleanNoSet to true if you don’t want to generate a activity for the stream.
dealobjectNodeal

centralstationcrm_deals_projects_put_api_projects_by_id

Update a project Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
no_logbooleanNoSet to true if you don’t want to generate a activity for the stream.
projectobjectNoproject