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

Tools

ToolDescription
centralstationcrm_activities_delete_api_cal_events_by_cal_event_id_cal_event_attendees_by_idDestroy a cal event attendee
centralstationcrm_activities_delete_api_cal_events_by_idDestroy a cal event
centralstationcrm_activities_delete_api_comments_by_idDestroy a comment
centralstationcrm_activities_delete_api_protocols_by_idDestroy a protocol
centralstationcrm_activities_delete_api_protocols_by_protocol_id_attachments_by_iddelete attachment
centralstationcrm_activities_delete_api_tasks_by_idDestroy a task
centralstationcrm_activities_get_api_activitiesRetrieves activities for the record
centralstationcrm_activities_get_api_activities_by_idretrieve activity
centralstationcrm_activities_get_api_activities_countRetrieves activities count for the record, account or user
centralstationcrm_activities_get_api_cal_eventsRetrieves all cal events of the account
centralstationcrm_activities_get_api_cal_events_by_cal_event_id_cal_event_attendeesRetrieves all cal event attendees
centralstationcrm_activities_get_api_cal_events_by_cal_event_id_cal_event_attendees_by_idRetrieves a cal event attendee
centralstationcrm_activities_get_api_cal_events_by_idRetrieves a cal event
centralstationcrm_activities_get_api_commentsRetrieves all comments of the account
centralstationcrm_activities_get_api_comments_by_idRetrieves a comment
centralstationcrm_activities_get_api_historic_eventsRetrieves all historic_events of the account
centralstationcrm_activities_get_api_protocolsRetrieves all protocols
centralstationcrm_activities_get_api_protocols_by_idRetrieves a protocol
centralstationcrm_activities_get_api_protocols_by_protocol_id_attachmentsRetrieves all attachments
centralstationcrm_activities_get_api_protocols_by_protocol_id_attachments_by_idretrieve attachment
centralstationcrm_activities_get_api_protocols_countRetrieves total amount of protocols
centralstationcrm_activities_get_api_tasksRetrieves all tasks of the account
centralstationcrm_activities_get_api_tasks_by_idRetrieves a task
centralstationcrm_activities_post_api_cal_eventsCreates a cal event
centralstationcrm_activities_post_api_cal_events_by_cal_event_id_cal_event_attendeesCreates a cal event attendee
centralstationcrm_activities_post_api_commentsCreates a comment
centralstationcrm_activities_post_api_protocolsCreates a protocol
centralstationcrm_activities_post_api_protocols_by_protocol_id_attachmentscreate attachment
centralstationcrm_activities_post_api_tasksCreates a task
centralstationcrm_activities_put_api_cal_events_by_cal_event_id_cal_event_attendees_by_idUpdate a cal event attendee
centralstationcrm_activities_put_api_cal_events_by_idUpdate a cal event
centralstationcrm_activities_put_api_comments_by_idUpdate a comment
centralstationcrm_activities_put_api_protocols_by_idUpdate a protocol
centralstationcrm_activities_put_api_tasks_by_idUpdate a task

centralstationcrm_activities_delete_api_cal_events_by_cal_event_id_cal_event_attendees_by_id

Destroy a cal event attendee Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
cal_event_idstringYescal_event_id

centralstationcrm_activities_delete_api_cal_events_by_id

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

centralstationcrm_activities_delete_api_comments_by_id

Destroy a comment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid

centralstationcrm_activities_delete_api_protocols_by_id

Destroy a protocol Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid

centralstationcrm_activities_delete_api_protocols_by_protocol_id_attachments_by_id

delete attachment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
protocol_idintegerYesprotocol_id

centralstationcrm_activities_delete_api_tasks_by_id

Destroy a task Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid

centralstationcrm_activities_get_api_activities

Retrieves activities for the record Parameters:
ParameterTypeRequiredDefaultDescription
perpageintegerNoElements per page, maximum of 250
pageintegerNoRetrieve records of the given page
orderstringNoOrdering of records using one of the following order options: occurred_at-asc, occurred_at-desc, id-asc, id-desc
includesstringNopossible includes are: user, activity_receivers separated by space. Receive all includes using the ‘all’ value.
methodsstringNoPossible methods are: attachable, responsible_user_natural_name separated by space. Receive all methods using the ‘all’ value.
filterobjectNoOptionally submit one of the activities 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' }).
person_idintegerNoID of the desired person activities
company_idintegerNoOptional ID of the desired company activities
deal_idintegerNoOptional ID of the desired deal activities
project_idintegerNoOptional ID of the desired project activities
user_idintegerNoID of the desired user activities
account_idintegerNoID of the desired account activities

centralstationcrm_activities_get_api_activities_by_id

retrieve activity Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
includesstringNopossible includes are: user, activity_receivers separated by space. Receive all includes using the ‘all’ value.
methodsstringNoPossible methods are: attachable, responsible_user_natural_name separated by space. Receive all methods using the ‘all’ value.
filterobjectNoOptionally submit one of the activities 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_activities_get_api_activities_count

Retrieves activities count for the record, account or user Parameters:
ParameterTypeRequiredDefaultDescription
perpageintegerNoElements per page, maximum of 250
pageintegerNoRetrieve records of the given page
includesstringNopossible includes are: user, activity_receivers separated by space. Receive all includes using the ‘all’ value.
methodsstringNoPossible methods are: attachable, responsible_user_natural_name separated by space. Receive all methods using the ‘all’ value.
person_idintegerNoID of the desired person activities
company_idintegerNoID of the desired company activities
deal_idintegerNoID of the desired deal activities
project_idintegerNoID of the desired project activities
account_idintegerNoID of the desired account activities

centralstationcrm_activities_get_api_cal_events

Retrieves all cal events of the account 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 includes are: user, group_calendar, people, users, cal_event_attendees, comments separated by space. Receive all includes using the ‘all’ value.
statestringNoOptionally submit upcoming or old to return only those CalEvents
beforestringNoOptionally submit a date formatted YYYY-MM-DD to return only CalEvents before this date
afterstringNoOptionally submit a date formatted YYYY-MM-DD to return only CalEvents after this date
filterobjectNoOptionally submit one of the calevents 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_activities_get_api_cal_events_by_cal_event_id_cal_event_attendees

Retrieves all cal event attendees Parameters:
ParameterTypeRequiredDefaultDescription
cal_event_idstringYescal_event_id
includesstringNopossible includes are: user, person, cal_event separated by space. Receive all includes using the ‘all’ value.
orderstringNoOrdering of records using one of the following order options: id-asc, id-desc

centralstationcrm_activities_get_api_cal_events_by_cal_event_id_cal_event_attendees_by_id

Retrieves a cal event attendee Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
cal_event_idstringYescal_event_id
includesstringNopossible includes are: user, person, cal_event separated by space. Receive all includes using the ‘all’ value.

centralstationcrm_activities_get_api_cal_events_by_id

Retrieves a cal event Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
includesstringNopossible includes are: user, group_calendar, people, users, cal_event_attendees, comments separated by space. Receive all includes using the ‘all’ value.

centralstationcrm_activities_get_api_comments

Retrieves all comments of the account 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
methodsstringNoPossible option: responsible_user_natural_name

centralstationcrm_activities_get_api_comments_by_id

Retrieves a comment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
methodsstringNoPossible option: responsible_user_natural_name

centralstationcrm_activities_get_api_historic_events

Retrieves all historic_events of the account 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
filterobjectNoOptionally submit one of the historicevents attributes in order to filter by them (e.g. { ‘name’: { ‘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' }).
date_fromstringNoOptionally submit a date_from in order to filter the HistoricEvents after and before the submitted dates.Once you submit the date_from param, the date_to param is mandatory too.
date_tostringNoOptionally submit a date_to in order to filter the HistoricEvents after and before the submitted dates.Once you submit the date_to param, the date_from param is mandatory too.

centralstationcrm_activities_get_api_protocols

Retrieves all protocols 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
methodsstringNoPossible methods are: responsible_user_natural_name, absolute_url, conversion_step_names separated by space. Receive all methods using the ‘all’ value.
includesstringNopossible option: comments
person_idintegerNoOptional ID of the desired person
company_idintegerNoOptional ID of the desired company protocols
deal_idintegerNoOptional ID of the desired deal protocols
project_idintegerNoOptional ID of the desired project protocols

centralstationcrm_activities_get_api_protocols_by_id

Retrieves a protocol Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
methodsstringNoPossible methods are: responsible_user_natural_name, absolute_url, conversion_step_names separated by space. Receive all methods using the ‘all’ value.
includesstringNopossible option: comments

centralstationcrm_activities_get_api_protocols_by_protocol_id_attachments

Retrieves all attachments Parameters:
ParameterTypeRequiredDefaultDescription
includesstringNopossible includes are: user, attachment_category, comments separated by space. Receive all includes using the ‘all’ value.
methodsstringNoPossible methods are: responsible_user_natural_name, attachment_category_name separated by space. Receive all methods using the ‘all’ value.
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
protocol_idintegerYesprotocol_id

centralstationcrm_activities_get_api_protocols_by_protocol_id_attachments_by_id

retrieve attachment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
protocol_idintegerYesprotocol_id
includesstringNopossible includes are: user, attachment_category, comments separated by space. Receive all includes using the ‘all’ value.
methodsstringNoPossible methods are: responsible_user_natural_name, attachment_category_name separated by space. Receive all methods using the ‘all’ value.

centralstationcrm_activities_get_api_protocols_count

Retrieves total amount of protocols

centralstationcrm_activities_get_api_tasks

Retrieves all tasks of the account 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 includes are: user, comments separated by space. Receive all includes using the ‘all’ value.
methodsstringNoPossible option: responsible_user_natural_name
statestringNoOptionally submit open or closed to return only those tasks
beforestringNoOptionally submit a date formatted YYYY-MM-DD to return only tasks before this date
afterstringNoOptionally submit a date formatted YYYY-MM-DD to return only tasks after this date
user_idstringNooptional parameter to filter by a users ID

centralstationcrm_activities_get_api_tasks_by_id

Retrieves a task Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
includesstringNopossible includes are: user, comments separated by space. Receive all includes using the ‘all’ value.
methodsstringNoPossible option: responsible_user_natural_name

centralstationcrm_activities_post_api_cal_events

Creates a cal event Parameters:
ParameterTypeRequiredDefaultDescription
includesstringNopossible includes are: user, group_calendar, people, users, cal_event_attendees, comments separated by space. Receive all includes using the ‘all’ value.
no_logbooleanNoSet to true if you don’t want to generate a activity for the stream.
cal_eventobjectNocal_event

centralstationcrm_activities_post_api_cal_events_by_cal_event_id_cal_event_attendees

Creates a cal event attendee Parameters:
ParameterTypeRequiredDefaultDescription
cal_event_idstringYescal_event_id
cal_event_attendeeobjectNocal_event_attendee

centralstationcrm_activities_post_api_comments

Creates a comment Parameters:
ParameterTypeRequiredDefaultDescription
methodsstringNoPossible option: responsible_user_natural_name
commentobjectNocomment

centralstationcrm_activities_post_api_protocols

Creates a protocol Parameters:
ParameterTypeRequiredDefaultDescription
only_object_loggingbooleanNoSet to true if you want the new protocol only to show up on the object pages, not on the status stream.
methodsstringNoPossible methods are: responsible_user_natural_name, absolute_url, conversion_step_names separated by space. Receive all methods using the ‘all’ value.
includesstringNopossible option: comments
attachmentobjectNoattachment
protocolobjectNoprotocol

centralstationcrm_activities_post_api_protocols_by_protocol_id_attachments

create attachment Parameters:
ParameterTypeRequiredDefaultDescription
includesstringNopossible includes are: user, attachment_category, comments separated by space. Receive all includes using the ‘all’ value.
methodsstringNoPossible methods are: responsible_user_natural_name, attachment_category_name separated by space. Receive all methods using the ‘all’ value.
protocol_idintegerYesprotocol_id
attachmentobjectNoattachment

centralstationcrm_activities_post_api_tasks

Creates a task Parameters:
ParameterTypeRequiredDefaultDescription
includesstringNopossible includes are: user, comments separated by space. Receive all includes using the ‘all’ value.
methodsstringNoPossible option: responsible_user_natural_name
taskobjectNotask

centralstationcrm_activities_put_api_cal_events_by_cal_event_id_cal_event_attendees_by_id

Update a cal event attendee Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
cal_event_idstringYescal_event_id
cal_event_attendeeobjectNocal_event_attendee

centralstationcrm_activities_put_api_cal_events_by_id

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

centralstationcrm_activities_put_api_comments_by_id

Update a comment Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
commentobjectNocomment

centralstationcrm_activities_put_api_protocols_by_id

Update a protocol Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
attachmentobjectNoattachment
protocolobjectNoprotocol

centralstationcrm_activities_put_api_tasks_by_id

Update a task Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
taskobjectNotask