Skip to main content
CentralStationCRM logo
  • Category: crm
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 186
  • Triggers: 0
  • Slug: CENTRALSTATIONCRM
  • Version: 20261101_00

Tools

Slug: CENTRALSTATIONCRM_CHECK_CONNECTIONTool to verify the connection status of the CentralStationCRM API key. Use when validating credentials before making other API calls.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_COUNT_ACTIVITIESRetrieve an activities count, optionally filtered by person, company, deal, project, or account.

Input Parameters

integer
Retrieve records of the given page.
integer
ID of the desired deal activities.
string
Possible methods are: attachable, responsible_user_natural_name separated by space. Receive all methods using the ‘all’ value.
integer
Elements per page, maximum of 250.
string
Possible includes are: user, activity_receivers separated by space. Receive all includes using the ‘all’ value.
integer
ID of the desired person activities.
integer
ID of the desired account activities.
integer
ID of the desired company activities.
integer
ID of the desired project activities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_COUNT_ATTACHMENTSTool to retrieve the total count and total file size of attachments. Use when you need to know how many attachments exist and their combined size in the CentralStationCRM account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_COUNT_AVATARSTool to retrieve the total count and total file size of avatars in the system. Use when you need statistics about avatar storage, such as total number of avatar files and their combined storage size.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_COUNT_COMPANIES_EXTERNAL_EMAILSTool to retrieve the total amount of external emails for a specific company. Use when you need to count how many external emails are associated with a particular company in CentralStationCRM.

Input Parameters

integer
required
ID of the company to retrieve external email count for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_COUNT_DEALS_EXTERNAL_EMAILSTool to retrieve the total amount of external emails for a specific deal. Use when you need to count how many external emails are associated with a particular deal in CentralStationCRM.

Input Parameters

integer
required
ID of the deal to retrieve external email count for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_COUNT_EXTERNAL_EMAILSTool to retrieve the total amount of external emails. Use when you need to count all external emails in CentralStationCRM.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_COUNT_PEOPLE2Tool to retrieve the total count of people with optional filtering capabilities. Use when you need to count people by tags or specific attributes. Supports filtering by tag ID, tag name, or custom filter expressions.

Input Parameters

object
Optionally submit one of the people 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' }).
integer
Optionally submit a tag ID in order to only see people tagged with the submitted tag
string
Optionally submit a tag name in order to only see people tagged with the submitted tag

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_COUNT_PEOPLE_EXTERNAL_EMAILSTool to retrieve the total amount of external emails for a specific person. Use when you need to count how many external emails are associated with a particular person in CentralStationCRM.

Input Parameters

integer
required
ID of the person to retrieve external email count for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_COUNT_PROJECTS_EXTERNAL_EMAILSTool to retrieve the total amount of external emails for a specific project. Use when you need to count how many external emails are associated with a particular project in CentralStationCRM.

Input Parameters

integer
required
ID of the project to retrieve external email count for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_COUNT_PROTOCOLSTool to retrieve the total number of protocols in the account. Use when you need the current total number of protocols in your CentralStationCRM account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_ATTACHMENTSTool to create a new attachment in CentralStationCRM. Use when you need to upload a Base64-encoded file to attach to records like people, companies, or deals.

Input Parameters

string
Additional methods to apply (space-separated): responsible_user_natural_name, attachment_category_name. Use ‘all’ for all methods.
string
Related entities to include in response (space-separated): user, attachment_category, comments. Use ‘all’ for all includes.
object
required
Attachment object with filename, content type, and Base64 data

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_CAL_EVENTTool to create a new calendar event in CentralStationCRM. Use when scheduling meetings, appointments, or other time-based events.

Input Parameters

boolean
Set to true if you don’t want to generate an activity for the stream
string
Comma or space-separated list of related entities to include in response (e.g., ‘user group_calendar people users cal_event_attendees comments’). Use ‘all’ to receive all available includes.
object
required
Calendar event object containing all event details

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_CAL_EVENT_ATTENDEETool to create a calendar event attendee. Use when you need to add an attendee to an existing calendar event.

Input Parameters

string
Email address of the attending person or user. Invitations will be sent to this address if email_notifications is set to true for the related cal event
string ("new" | "invited" | "no_invite" | "accepted" | "rejected" | "perhaps" | "canceled")
required
Attendance status of the invitee
integer
ID of the related CSCRM user. Either person_id or user_id must be set to valid records
integer
ID of the related CSCRM person. Either person_id or user_id must be set to valid records
string
required
The unique identifier of the calendar event to add the attendee to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_COMMENTTool to create a new comment on an entity (task, event, protocol, etc.). Use when you need to add notes or feedback to existing CRM records.

Input Parameters

object
required
Comment object containing all comment details
string
Optional methods parameter. Possible value: responsible_user_natural_name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_COMPANIESTool to create a company with nested attributes. Use when you need to add a company with associated contact details, custom fields, or avatar in a single request.

Input Parameters

boolean
Set to true if you don’t want to generate an activity for the stream
object
required
Company data including nested attributes
string
Possible methods: responsible_user_natural_name, related_tasks, stream_updated_at, absolute_url (space-separated). Use ‘all’ for all methods.
string
Possible includes: positions, deals, projects, tags, tasks, pending_tasks, cal_events, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, connections, custom_fields (space-separated). Use ‘all’ for all includes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_COMPANIES_AVATARSTool to create an avatar for a company. Use when you need to add a profile image or logo to a company record.

Input Parameters

object
required
Avatar data object containing filename, content type, and base64-encoded image data
string
required
Unique identifier of the company to add the avatar to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_COMPANIES_PROTOCOLS_ATTACHMENTSTool to create an attachment for a company protocol in CentralStationCRM. Use when you need to upload a Base64-encoded file to a specific protocol within a company.

Input Parameters

string
Additional methods to apply (space-separated): responsible_user_natural_name, attachment_category_name. Use ‘all’ for all methods.
string
Related entities to include in response (space-separated): user, attachment_category, comments. Use ‘all’ for all includes.
object
required
Attachment object with filename, content type, and Base64 data
integer
required
ID of the company the protocol belongs to
integer
required
ID of the protocol to attach the file to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_COMPANY_ADDRESSTool to create a new address for a specific company. Use when you need to add postal details to a company record after confirming company ID.

Input Parameters

string
The postal code
string
required
The city name (required)
string ("work_hq" | "work" | "invoice" | "delivery" | "private" | "other")
required
Address type. Must be one of work_hq, work, invoice, delivery, private or other.
string
The street including house number or other details (building, c/o)
boolean
Decides ordering of addresses when the company has multiple addresses
boolean
States whether the address has been added via the API or some sort of integration
integer
required
The unique identifier of the company to add the address to
string
The state code (e.g. NW, BY). Must match the country code.
string
The country code (ISO 3166-1 alpha-2, e.g. DE, AT)
integer
required
The ID of the record the address belongs to. Will be auto set when using nested attributes.
string ("Person" | "Company")
required
The record type the address belongs to. Must be either Person or Company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_COMPANY_CONTACT_DETAILTool to create a new contact detail for a specific company. Use when adding a phone number after confirming the company’s ID.

Input Parameters

string
required
The phone number or contact value.
string ("office" | "office_hq" | "mobile" | "fax" | "private" | "voip" | "skype" | "other")
required
Phone type. Must be one of office, office_hq, mobile, fax, private, voip, skype or other.
integer
required
The unique identifier of the company to add the contact detail to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_CUSTOM_FIELDS_TYPETool to create a new custom field type in CentralStationCRM. Use when you need to define a new custom field that can be applied to Person, Company, Deal, or Project entities.

Input Parameters

object
required
The custom field type data to create

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_DEAL_PROTOCOL_ATTACHMENTTool to create an attachment for a deal protocol. Use when you need to attach a file (document, image, etc.) to a specific protocol within a deal. The file content must be base64-encoded.

Input Parameters

integer
required
ID of the deal to which the protocol belongs
string
Additional methods to include in response. Options: ‘responsible_user_natural_name’, ‘attachment_category_name’, or ‘all’ for all methods. Separate multiple values with spaces.
string
Related entities to include in response. Options: ‘user’, ‘attachment_category’, ‘comments’, or ‘all’ for all includes. Separate multiple values with spaces.
object
required
Attachment data including filename, content type, and base64-encoded file content
integer
required
ID of the protocol to attach the file to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_DEALSTool to create a new deal in CentralStationCRM. Use when you need to add a sales opportunity with details like name, value, pipeline, and associated contacts. Supports nested attributes like custom_fields_attributes and tags_attributes.

Input Parameters

object
required
Deal data to create
boolean
Set to true if you don’t want to generate an activity for the stream
string
Possible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the ‘all’ value
string
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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_GROUP_CALENDARSTool to create a new group calendar in CentralStationCRM. Use when setting up shared calendars for teams or specific purposes like holidays.

Input Parameters

object
required
Group calendar object containing all calendar details

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_HOOKTool to create a webhook hook in CentralStationCRM. Use when you need to set up automatic notifications for create, update, or destroy events on Person, Company, Deal, or Project records.

Input Parameters

string ("create" | "update" | "destroy")
required
Activity that shall trigger the hook (create, update, or destroy)
string ("Person" | "Company" | "Deal" | "Project")
required
Object type to be notified about (Person, Company, Deal, or Project)
string ("active" | "disabled")
Indicating if the hook is enabled or not.
array
Methods depending on the hook model, e.g. salutation_official for Person
string
Only relevant for object_types nested, api and hook_with_structure_and_record. Subrecords may be specified comma-separated and will be included within the webhooks data (e.g. tags, addrs, historic_events)
string ("url")
required
Hook type - currently only ‘url’ is supported
string
required
URL to which the webhook should be sent
string ("nested" | "api" | "lean" | "hook_with_structure_and_record")
required
Data structure of the webhook (nested, api, lean, or hook_with_structure_and_record)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_PEOPLETool to create a person with nested attributes. Use when adding a person with contact details, custom fields, or other nested data in a single request.

Input Parameters

boolean
Set to true if you don’t want to generate an activity for the stream
object
required
The person data including nested attributes
string
Possible methods are: responsible_user_natural_name, salutation_official, salutation_formal, salutation_informal, backlink, stream_updated_at, absolute_url, absolute_avatar_url separated by space. Receive all methods using the ‘all’ value.
string
Possible includes are: positions, companies, deals, projects, tags, tasks, tasks_pending, pending_tasks, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, addrs_from_company, custom_fields, historic_events, assis, connections, user separated by space. Receive all includes using the ‘all’ value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_PEOPLE_CUSTOM_FIELDTool to create a custom field for a person record. Use when you need to add custom metadata or attributes to a person.

Input Parameters

integer
required
ID of the person the custom fields belong to
object
required
The custom field object containing the field details

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_PEOPLE_POSITIONSTool to create a new position for a specific person. Use when you need to associate a person with a company role or job position.

Input Parameters

object
required
Position details to create
integer
required
The unique identifier of the person to add the position to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_PEOPLE_PROTOCOLS_ATTACHMENTSTool to create an attachment for a person protocol in CentralStationCRM. Use when you need to upload a Base64-encoded file to a specific protocol within a person record.

Input Parameters

string
Additional methods to apply (space-separated): responsible_user_natural_name, attachment_category_name. Use ‘all’ for all methods.
string
Related entities to include in response (space-separated): user, attachment_category, comments. Use ‘all’ for all includes.
integer
required
ID of the person the protocol belongs to
object
required
Attachment object with filename, content type, and Base64 data
integer
required
ID of the protocol to attach the file to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_PEOPLE_TAGSTool to create a new tag for a specific person. Use when you need to categorize or label a person after confirming their ID.

Input Parameters

object
required
The tag object containing the tag details
integer
required
The unique identifier of the person to add the tag to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_PERSON_ADDRESSCreate a new postal address for a specific person.

Input Parameters

string
The postal code
string
required
The city name (required)
string ("work_hq" | "work" | "invoice" | "delivery" | "private" | "other")
required
Address type. Must be one of work_hq, work, invoice, delivery, private or other.
string
The street including house number or other details (building, c/o)
boolean
Decides ordering of addresses when the person has multiple addresses
integer
required
The unique identifier of the person to add the address to
string
The state code (e.g. NW, BY)
string
The country code (ISO 3166-1 alpha-2, e.g. DE, AT)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_PERSON_ASSITool to create a new assistant (assi) entry for a specific person. Use after confirming the person ID when you need to manage assistant contacts.

Input Parameters

string
Phone number of the assistant
string
required
Name of the assistant
string
Email address of the assistant
boolean
Whether the assistant is the primary contact
integer
required
ID of the person to add the assistant to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_PERSON_AVATARTool to create a new avatar for a specific person. Use when you need to attach a Base64-encoded image file after confirming the person’s ID.

Input Parameters

object
required
Avatar object with filename, content type, and Base64 data
integer
required
The ID of the person to attach the avatar to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_PERSON_CONTACT_DETAILTool to create a new contact detail for a specific person. Use when adding a phone number after confirming the person’s ID.

Input Parameters

string
required
The phone number or contact value.
string ("office" | "office_hq" | "mobile" | "fax" | "private" | "voip" | "skype" | "other")
required
Phone type. Must be one of office, office_hq, mobile, fax, private, voip, skype or other.
integer
required
The unique identifier of the person to add the contact detail to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_PERSON_HISTORIC_EVENTTool to create a new historic event for a specific person. Use after confirming person ID to record dates like birthdays, anniversaries, or other milestones.

Input Parameters

string
For atype ‘other’, an additional description may be provided. Ignored otherwise.
string
required
The date of the historic event in YYYY-MM-DD format.
string ("birthday" | "anniversary" | "first_met" | "renewal" | "other")
required
Type of the historic event. Must be one of birthday, anniversary, first_met, renewal or other.
integer
required
The unique identifier of the person to add the historic event to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_PROJECTTool to create a new project record. Use when you need to add a project to your CRM with optional nested attributes like custom fields and tags.

Input Parameters

string
required
Name of the project
boolean
Set to true if you don’t want to generate an activity for the stream
integer
ID of the deal associated with this project
string
Possible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Use ‘all’ to receive all methods.
integer
ID of the user responsible for this project
integer
ID of the group to which the project belongs
string
Possible includes are: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields separated by space. Use ‘all’ to receive all includes.
string
Additional background information about the project
integer
ID of the company associated with this project
string
Date when the project was finished in YYYY-MM-DD format
string
required
Target completion date in YYYY-MM-DD format
string
Current state of the project
string
Comma-separated person IDs to associate with the project (e.g., ‘42,4711’)
array
List of tag attributes to add to the project
array
List of custom field attributes to add to the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_PROJECTS_PROTOCOLS_ATTACHMENTSTool to create an attachment for a project protocol in CentralStationCRM. Use when you need to upload a Base64-encoded file to a specific protocol within a project.

Input Parameters

string
Additional methods to apply (space-separated): responsible_user_natural_name, attachment_category_name. Use ‘all’ for all methods.
string
Related entities to include in response (space-separated): user, attachment_category, comments. Use ‘all’ for all includes.
object
required
Attachment object with filename, content type, and Base64 data
integer
required
ID of the project the protocol belongs to
integer
required
ID of the protocol to attach the file to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_PROTOCOLTool to create a new protocol entry. Use when you need to log an activity, note, or communication related to people, companies, deals, or projects.

Input Parameters

string
Possible methods are: responsible_user_natural_name, absolute_url, conversion_step_names separated by space. Receive all methods using the ‘all’ value
string
Possible option: comments
object
required
Protocol data to be created
object
Schema for optional attachment data when creating a protocol.
boolean
Set to true if you want the new protocol only to show up on the object pages, not on the status stream

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_PROTOCOLS_ATTACHMENTSTool to create an attachment for a protocol in CentralStationCRM. Use when you need to upload a Base64-encoded file to a specific protocol.

Input Parameters

string
Additional methods to apply (space-separated): responsible_user_natural_name, attachment_category_name. Use ‘all’ for all methods.
string
Related entities to include in response (space-separated): user, attachment_category, comments. Use ‘all’ for all includes.
object
required
Attachment object with filename, content type, and Base64 data
integer
required
ID of the protocol to attach the file to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_TAGSTool to create a new tag for a person, company, or deal. Use when you need to categorize or label CRM records.

Input Parameters

string
required
Name of the tag to create (max 60 characters)
boolean
States whether or not the tag has been added via the API or some sort of integration
integer
required
ID of the record the tag belongs to (e.g., a person, company, or deal)
string
required
Type of record to attach the tag to. Must be one of: Person, Company, Deal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_CREATE_TASKSTool to create a new task record. Use when you need to add a task to a user’s workflow or attach it to an existing person, company, or deal.

Input Parameters

object
required
Task data object containing all task properties
string
Optional method to include: ‘responsible_user_natural_name’
string
Optional includes for the response: ‘user’, ‘comments’ separated by space, or ‘all’ for all includes

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_ATTACHMENTSTool to delete an attachment by ID. Use when you need to permanently remove an attachment after verifying the correct attachment ID.

Input Parameters

string
required
Unique identifier of the attachment to delete. Must be a string (UUID format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_AVATARSTool to delete an avatar by its ID. Use when you need to remove an avatar from the system after confirming the avatar ID.

Input Parameters

string
required
Unique identifier of the avatar to delete. Must be a string (e.g., UUID).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_CAL_EVENTTool to delete a calendar event by ID. Use when you need to permanently remove a calendar event after verifying the correct ID.

Input Parameters

string
required
Unique identifier of the calendar event to delete. UUID format.
boolean
Set to true if you don’t want to generate an activity for the stream.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_CAL_EVENT_ATTENDEETool to delete a calendar event attendee by ID. Use when you need to remove an attendee from a calendar event.

Input Parameters

string
required
Unique identifier of the calendar event attendee to delete. Must be a valid UUID string.
string
required
Unique identifier of the calendar event. Must be a valid UUID string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_COMMENTTool to delete a comment by its ID. Use when you need to permanently remove a comment after verifying the correct ID.

Input Parameters

integer
required
Unique identifier of the comment to delete. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_COMPANIES_AVATARSTool to delete a company’s avatar by its ID. Use when you need to remove an outdated or incorrect avatar after confirming the company_id and avatar ID.

Input Parameters

string
required
Unique identifier of the avatar to delete (typically a UUID).
string
required
Unique identifier of the company to which the avatar belongs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_COMPANIES_CONTACT_DETAILTool to delete a contact detail of a company. Use when you need to remove an outdated or incorrect contact detail after confirming the company_id and contact_detail_id.

Input Parameters

integer
required
Unique identifier of the contact detail to delete. Must be a positive integer.
integer
required
Unique identifier of the company to which the contact detail belongs. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_COMPANIES_PROTOCOLS_ATTACHMENTSTool to delete a specific attachment from a company protocol. Use when you need to permanently remove an attachment from a protocol after verifying the correct company ID, protocol ID, and attachment ID.

Input Parameters

string
required
Unique identifier of the attachment to delete (UUID format).
integer
required
ID of the company the protocol belongs to.
integer
required
ID of the protocol the attachment belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_COMPANYTool to delete a company record by ID. Use when you need to permanently remove an organization after verifying the correct ID.

Input Parameters

integer
required
Unique identifier of the company to delete. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_COMPANY_ADDRESSTool to delete a company’s address by its ID. Use when you need to remove an outdated or incorrect address after confirming the company_id and address_id.

Input Parameters

integer
required
Unique identifier of the address to delete. Must be a positive integer.
integer
required
Unique identifier of the company to which the address belongs. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_CUSTOM_FIELDS_TYPESTool to delete a custom field type by ID. Use when you need to permanently remove a custom field definition after verifying the correct ID.

Input Parameters

string
required
Unique identifier of the custom field type to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_DEALSTool to delete a deal record by ID. Use when you need to permanently remove a deal after verifying the correct ID.

Input Parameters

integer
required
Unique identifier of the deal to delete. Must be a positive integer.
boolean
Set to true if you don’t want to generate an activity for the stream.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_DEALS_PROTOCOLS_ATTACHMENTSTool to delete a specific attachment from a deal protocol. Use when you need to permanently remove an attachment from a protocol after verifying the correct deal ID, protocol ID, and attachment ID.

Input Parameters

string
required
Unique identifier of the attachment to delete (UUID format).
integer
required
ID of the deal the protocol belongs to.
integer
required
ID of the protocol the attachment belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_GROUP_CALENDARTool to delete a group calendar by ID. Use when you need to permanently remove a group calendar after verifying the correct ID.

Input Parameters

string
required
Unique identifier of the group calendar to delete. UUID format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_HOOKSTool to delete a webhook by ID. Use when you need to destroy a hook after verifying the correct ID.

Input Parameters

integer
required
Unique identifier of the hook to delete. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_PEOPLE_CUSTOM_FIELDSTool to delete a person’s custom field by its ID. Use when you need to remove a custom field after confirming the person_id and custom field id.

Input Parameters

integer
required
Unique identifier of the custom field to delete. Must be a positive integer.
integer
required
Unique identifier of the person to which the custom field belongs. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_PEOPLE_POSITIONSTool to delete a position of a person by its ID. Use when you need to remove a job position or company affiliation after confirming the person_id and position_id.

Input Parameters

integer
required
Unique identifier of the person to which the position belongs. Must be a positive integer.
integer
required
Unique identifier of the position to delete. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_PEOPLE_PROTOCOLS_ATTACHMENTSTool to delete a specific attachment from a person protocol. Use when you need to permanently remove an attachment from a protocol after verifying the correct person ID, protocol ID, and attachment ID.

Input Parameters

string
required
Unique identifier of the attachment to delete (UUID format).
integer
required
ID of the person the protocol belongs to.
integer
required
ID of the protocol the attachment belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_PERSONTool to delete a person record by ID. Use when you need to permanently remove a contact after verifying the correct ID.

Input Parameters

integer
required
Unique identifier of the person to delete. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_PERSON_ADDRESSTool to delete a person’s address by its ID. Use when you need to remove an outdated or incorrect address after confirming the person_id and address_id.

Input Parameters

integer
required
Unique identifier of the person to which the address belongs. Must be a positive integer.
integer
required
Unique identifier of the address to delete. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_PERSON_ASSITool to delete an assi entry of a person. Use when you need to remove an assistant record after confirming person_id and assi_id.

Input Parameters

integer
required
Unique identifier of the assi entry to delete. Must be a positive integer.
integer
required
Unique identifier of the person whose assi entry will be deleted. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_PERSON_AVATARTool to delete a person’s avatar by its ID. Use when you need to remove an outdated or incorrect avatar after confirming the person_id and avatar_id.

Input Parameters

string
required
Unique identifier of the avatar to delete. Must be a string (e.g., UUID).
integer
required
Unique identifier of the person to which the avatar belongs. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_PERSON_CONTACT_DETAILTool to delete a contact detail of a person. Use when you need to remove an outdated or incorrect contact detail after confirming the person_id and contact_detail_id.

Input Parameters

integer
required
Unique identifier of the person to which the contact detail belongs. Must be a positive integer.
integer
required
Unique identifier of the contact detail to delete. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_PERSON_HISTORIC_EVENTTool to delete a historic event of a person by its ID. Use when you need to remove outdated or incorrect milestone entries after confirming the person_id and historic_event_id.

Input Parameters

integer
required
Unique identifier of the person to which the historic event belongs. Must be a positive integer.
integer
required
Unique identifier of the historic event to delete. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_PERSON_TAGTool to destroy a tag from a person by its ID. Use when you need to remove a tag association from a person’s record after confirming the person_id and tag_id.

Input Parameters

string
required
Unique identifier of the tag to delete from the person.
integer
required
Unique identifier of the person from which the tag will be removed. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_PROJECTSTool to delete a project record by ID. Use when you need to permanently remove a project after verifying the correct ID.

Input Parameters

integer
required
Unique identifier of the project to delete. Must be a positive integer.
boolean
Set to true if you don’t want to generate an activity for the stream.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_PROJECTS_PROTOCOLS_ATTACHMENTSTool to delete a specific attachment from a project protocol. Use when you need to permanently remove an attachment from a protocol after verifying the correct project ID, protocol ID, and attachment ID.

Input Parameters

string
required
Unique identifier of the attachment to delete (UUID format).
integer
required
ID of the project the protocol belongs to.
integer
required
ID of the protocol the attachment belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_PROTOCOLTool to delete a protocol by ID. Use when you need to permanently remove a protocol record after verifying the correct ID.

Input Parameters

integer
required
Unique identifier of the protocol to delete. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_PROTOCOLS_ATTACHMENTSTool to delete an attachment from a protocol. Use when you need to permanently remove an attachment from a protocol after verifying the correct protocol ID and attachment ID.

Input Parameters

string
required
Unique identifier of the attachment to delete (UUID format).
integer
required
ID of the protocol the attachment belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_DELETE_TASKSTool to delete a task by its ID. Use when you need to permanently remove a task after verifying the correct ID.

Input Parameters

integer
required
Unique identifier of the task to delete. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_ACTIVITYTool to retrieve details of a specific activity by its ID. Use when you have an activity ID and need its details.

Input Parameters

string
required
Unique identifier of the activity to retrieve
object
Optional filter object to filter by activity attributes. Supported modifiers: ‘smaller_than’, ‘larger_than’, ‘equal’, ‘between’, ‘in’.
string
Comma-separated list of computed methods to include. Possible values: ‘attachable’, ‘responsible_user_natural_name’. Use ‘all’ to include all methods.
string
Comma-separated list of related objects to include. Possible values: ‘user’, ‘activity_receivers’. Use ‘all’ to include everything.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_API_USER_MAILDROPTool to retrieve the current API user’s maildrop for people and companies. Use after authenticating the API user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_ATTACHMENTTool to retrieve details of a specific attachment by its ID. Use when you have an attachment ID and need to fetch the attachment metadata or file data.

Input Parameters

string
required
The unique ID of the attachment to retrieve (UUID format).
string
Optional space-separated list of computed methods to include in the response. Valid values: ‘responsible_user_natural_name’ (returns the full name of the responsible user), ‘attachment_category_name’ (returns the category name as a string). Use ‘all’ to include all methods. Example: ‘responsible_user_natural_name attachment_category_name’
string
Optional space-separated list of related objects to include in the response. Valid values: ‘user’ (uploader user), ‘attachment_category’ (category info), ‘comments’ (associated comments). Use ‘all’ to include everything. Example: ‘user attachment_category comments’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_AVATARSTool to retrieve a specific avatar by its ID from CentralStationCRM. Use when you know the avatar ID and need to fetch its details including Base64-encoded image data.

Input Parameters

string
required
Unique identifier (UUID) of the avatar to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_CAL_EVENTTool to retrieve details of a specific calendar event by ID. Use when you have a calendar event ID and need its full details.

Input Parameters

string
required
Unique identifier of the calendar event to retrieve (UUID format)
string
Space-separated list of related objects to include in the response. Valid values: ‘user’, ‘group_calendar’, ‘people’, ‘users’, ‘cal_event_attendees’, ‘comments’. Use ‘all’ to receive all includes. Example: ‘user group_calendar people’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_CAL_EVENT_ATTENDEETool to retrieve details of a specific calendar event attendee by ID. Use when you have both a calendar event ID and attendee ID.

Input Parameters

string
required
Unique identifier of the calendar event attendee
string
Space-separated list of related objects to include in the response. Possible values: ‘user’, ‘person’, ‘cal_event’. Use ‘all’ to receive all includes.
string
required
Unique identifier of the calendar event

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_COMMENTTool to retrieve details of a specific comment by its ID. Use when you need to fetch a comment’s content and metadata.

Input Parameters

string
required
Unique identifier of the comment to retrieve
string
Optional computed methods to include in the response. Example: ‘responsible_user_natural_name’ returns the full name of the responsible user. These add extra fields to the response.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_COMPANIES_AVATARSTool to retrieve a specific avatar of a company by avatar ID. Use when you need to fetch the Base64-encoded image for a known company avatar.

Input Parameters

string
required
Unique identifier (UUID) of the avatar to retrieve
string
required
Unique identifier of the company whose avatar is to be retrieved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_COMPANIES_PROTOCOLS_ATTACHMENTTool to retrieve a specific attachment from a company protocol by its ID. Use when you need to fetch attachment metadata or file data for a protocol attachment.

Input Parameters

string
required
The unique ID of the attachment to retrieve (UUID format).
string
Optional space-separated list of computed methods to include in the response. Valid values: ‘responsible_user_natural_name’ (returns the full name of the responsible user), ‘attachment_category_name’ (returns the category name as a string). Use ‘all’ to include all methods.
string
Optional space-separated list of related objects to include in the response. Valid values: ‘user’ (uploader user), ‘attachment_category’ (category info), ‘comments’ (associated comments). Use ‘all’ to include everything.
integer
required
ID of the company that owns the protocol.
integer
required
ID of the protocol that contains the attachment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_COMPANYTool to retrieve details of a specific company by ID from CentralStationCRM. Use after confirming the company ID.

Input Parameters

integer
required
Unique identifier of the company to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_COMPANY_ADDRESSTool to retrieve a specific address of a company by address ID. Use after confirming company and address IDs. Example: “Fetch address #40909645 for company #1809535128.”

Input Parameters

integer
required
ID of the address to retrieve
integer
required
ID of the company the address belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_COMPANY_CONTACT_DETAILTool to retrieve a specific contact detail by ID for a company. Use after confirming company and contact detail IDs. Example: “Fetch contact detail #104232123 for company #1809508479.”

Input Parameters

integer
required
ID of the contact detail
integer
required
ID of the company the contact details belong to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_CUSTOM_FIELDS_TYPETool to retrieve a custom field type by its ID. Use when you need details about a specific custom field configuration.

Input Parameters

string
required
Unique identifier of the custom field type to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_DEALTool to retrieve details of a specific deal by its ID. Use when you have a confirmed deal ID.

Input Parameters

integer
required
Unique identifier of the deal to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_DEALS_MAILDROPTool to retrieve the maildrop email address for a specific deal. Use when you need to get the unique email address for sending emails to a deal.

Input Parameters

integer
required
ID of the deal the maildrop belongs to. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_DEALS_PROTOCOLS_ATTACHMENTSTool to retrieve a specific attachment from a deal protocol. Use when you need to fetch attachment details or file data associated with a protocol within a specific deal.

Input Parameters

string
required
Unique identifier of the attachment to retrieve (UUID format)
integer
required
Unique identifier of the deal
string
Optional space-separated list of computed methods to include in the response. Valid values: ‘responsible_user_natural_name’ (returns the full name of the responsible user), ‘attachment_category_name’ (returns the category name as a string). Use ‘all’ to include all methods. Example: ‘responsible_user_natural_name attachment_category_name’
string
Optional space-separated list of related objects to include in the response. Valid values: ‘user’ (uploader user), ‘attachment_category’ (category info), ‘comments’ (associated comments). Use ‘all’ to include everything. Example: ‘user attachment_category comments’
integer
required
Unique identifier of the protocol within the deal

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_GROUP_CALENDARTool to retrieve details of a specific group calendar by ID. Use when you have a group calendar ID and need its details.

Input Parameters

string
required
Unique identifier of the group calendar to retrieve (UUID format)
string
Optional related objects to include in the response. Valid value: ‘cal_events’ to include calendar events associated with this group calendar.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_HOOKTool to retrieve details of a specific webhook/hook by ID. Use when you need to inspect hook configuration or verify hook setup.

Input Parameters

string
required
The unique ID of the hook to retrieve. Can be a string or numeric identifier.
string
Optional comma-separated list of related objects to include in the response. Valid value: ‘filter_groups’. When included, the response will contain associated filter group data.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_PEOPLE_POSITIONSTool to retrieve a specific position for a person by ID. Use when you need to get details of a particular job position. Example: “Get position 32171509 for person 43058116.”

Input Parameters

integer
required
Unique identifier of the position to retrieve
string
Comma-separated list of related objects to include. Possible includes: ‘person’, ‘company’. Use ‘all’ to receive all includes
integer
required
Unique identifier of the person

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_PEOPLE_PROTOCOLS_ATTACHMENTSTool to retrieve a specific attachment from a person protocol. Use when you need to fetch attachment details or file data associated with a protocol within a specific person.

Input Parameters

string
required
Unique identifier of the attachment to retrieve (UUID format)
string
Optional space-separated list of computed methods to include in the response. Valid values: ‘responsible_user_natural_name’ (returns the full name of the responsible user), ‘attachment_category_name’ (returns the category name as a string). Use ‘all’ to include all methods. Example: ‘responsible_user_natural_name attachment_category_name’
string
Optional space-separated list of related objects to include in the response. Valid values: ‘user’ (uploader user), ‘attachment_category’ (category info), ‘comments’ (associated comments). Use ‘all’ to include everything. Example: ‘user attachment_category comments’
integer
required
Unique identifier of the person
integer
required
Unique identifier of the protocol within the person

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_PEOPLE_TAGSTool to retrieve a specific tag for a person by tag ID. Use when you need details about a particular tag associated with a person.

Input Parameters

integer
required
ID of the tag to retrieve
integer
required
ID of the person the tag belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_PERSONTool to retrieve details of a specific person by ID. Use when you have a person_id and need their full details.

Input Parameters

array
Optional list of computed methods to include in the response. Example: ‘responsible_user_natural_name’ returns the full name of the responsible user. Available methods are documented in the CentralStationCRM Swagger API documentation. These add extra fields to the response.
array
Optional list of related objects to include in the response. Valid values: ‘companies’ (associated companies), ‘tags’ (associated tags). If included, the corresponding fields will be populated in the response.
integer
required
The unique ID of the person to retrieve. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_PERSON_ADDRESSTool to retrieve a specific address of a person by address ID. Use after confirming person and address IDs. Example: “Fetch address for person #42, address #101.”

Input Parameters

string
Optional comma-separated list of methods to include additional information. Example: ‘country_name’
integer
required
Unique identifier of the person whose address is to be retrieved
integer
required
Unique identifier of the address to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_PERSON_ADDRESSESRetrieve a page of addresses for a specific person. Use pagination to request further pages.

Input Parameters

integer
Page number to retrieve
string
Comma-separated list of methods to include additional information
integer
Number of entries per page (default is 50, max is 250)
string
Comma-separated list of related objects to include in the response
integer
required
Unique identifier of the person whose addresses are to be retrieved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_PERSON_ASSITool to retrieve a specific assistant (assi) entry for a person by their IDs. Returns detailed assistant information including contact details (name, email, phone) and whether they are the primary contact. Use this when you need full details about a specific assistant after obtaining both the person_id and assi_id.

Input Parameters

integer
required
Unique identifier of the specific assistant entry to retrieve
integer
required
Unique identifier of the person whose assistant entry you want to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_PERSON_AVATARTool to retrieve a specific avatar of a person by avatar ID. Use after you know both person_id and avatar_id to fetch the Base64-encoded image.

Input Parameters

string
required
Unique identifier (UUID) of the avatar to retrieve
integer
required
Unique identifier of the person whose avatar is to be retrieved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_PERSON_CONTACT_DETAILTool to retrieve a specific contact detail by ID for a person. Use after confirming person and contact detail IDs. Example: “Fetch contact detail #108 for person #42.”

Input Parameters

string
Optional comma-separated list of methods to include additional info, e.g., ‘responsible_user_natural_name’
integer
required
Unique identifier of the person whose contact detail is to be retrieved
integer
required
Unique identifier of the contact detail to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_PERSON_CUSTOM_FIELDTool to retrieve a specific custom field for a person by custom field ID. Use when you need details about a particular custom field associated with a person.

Input Parameters

integer
required
ID of the custom field to retrieve
string
Optional related data to include. Possible value: ‘custom_fields_type’ to include the custom field type definition
integer
required
ID of the person the custom field belongs to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_PERSON_HISTORIC_EVENTTool to retrieve a specific historic event of a person by ID. Use after confirming both person and event IDs. Example: “Fetch historic event 101 for person 42.”

Input Parameters

string
Optional comma-separated list of methods to include additional information.
integer
required
Unique identifier of the historic event to retrieve.
string
Optional comma-separated list of related resources to include.
integer
required
Unique identifier of the person.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_PROJECTTool to retrieve details of a specific project by ID from CentralStationCRM. Use after confirming the project ID.

Input Parameters

integer
required
Unique identifier of the project to retrieve
string
Space-separated list of additional methods to execute. Possible values: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at. Use ‘all’ to receive all methods.
string
Space-separated list of related data to include. Possible values: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields. Use ‘all’ to receive all includes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_PROJECTS_MAILDROPTool to retrieve the maildrop email address for a specific project. Use when you need to get the unique email address for sending emails to a project.

Input Parameters

integer
required
ID of the project the maildrop belongs to. Must be a positive integer.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_PROJECTS_PROTOCOLS_ATTACHMENTTool to retrieve a specific attachment from a project protocol by its ID. Use when you have a project ID, protocol ID, and attachment ID and need to fetch the attachment metadata or file data.

Input Parameters

string
required
Unique identifier of the attachment to retrieve (UUID format).
string
Optional space-separated list of computed methods to include in the response. Valid values: ‘responsible_user_natural_name’ (returns the full name of the responsible user), ‘attachment_category_name’ (returns the category name as a string). Use ‘all’ to include all methods.
string
Optional space-separated list of related objects to include in the response. Valid values: ‘user’ (uploader user), ‘attachment_category’ (category info), ‘comments’ (associated comments). Use ‘all’ to include everything.
integer
required
ID of the project the protocol belongs to.
integer
required
ID of the protocol the attachment belongs to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_PROTOCOLS_ATTACHMENTSTool to retrieve a specific attachment from a protocol by its ID. Use when you need to fetch attachment metadata or file data for a protocol attachment.

Input Parameters

string
required
The unique ID of the attachment to retrieve (UUID format).
string
Optional space-separated list of computed methods to include in the response. Valid values: ‘responsible_user_natural_name’ (returns the full name of the responsible user), ‘attachment_category_name’ (returns the category name as a string). Use ‘all’ to include all methods.
string
Optional space-separated list of related objects to include in the response. Valid values: ‘user’ (uploader user), ‘attachment_category’ (category info), ‘comments’ (associated comments). Use ‘all’ to include everything.
integer
required
ID of the protocol that contains the attachment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_STATS_COMPANIESRetrieve statistics about companies in your CRM. Returns the total count of companies matching the specified criteria. Use this when you need a quick count without fetching full company records. Supports filtering by tags and various field criteria (user_id, created_by_user_id, account_id, group_id, etc.) using operators like ‘equal’, ‘larger_than’, ‘smaller_than’, ‘between’, and ‘in’.

Input Parameters

object
Optionally submit one of the companies attributes in order to filter by them. 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’}). Common filterable fields include: user_id, created_by_user_id, updated_by_user_id, group_id, account_id. Example: {‘user_id’: {‘equal’: 42}} or {‘created_by_user_id’: {‘larger_than’: 100}}.
integer
Optionally submit a tag ID in order to only see companies tagged with the submitted tag.
string
Optionally submit a tag name in order to only see companies tagged with the submitted tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_STATS_DEALSRetrieve deal statistics, including the total count and, when available, currency and sum. Supports filtering by tags and field criteria using operators such as equal, larger_than, smaller_than, between, and in.

Input Parameters

object
Optionally submit one of the deals attributes in order to filter by them. 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’}). Common filterable fields include: user_id, created_by_user_id, updated_by_user_id, group_id, account_id. Example: {‘user_id’: {‘equal’: 42}} or {‘created_by_user_id’: {‘larger_than’: 100}}.
integer
Optionally submit a tag ID in order to only see deals tagged with the submitted tag.
string
Optionally submit a tag name in order to only see deals tagged with the submitted tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_STATS_PROJECTSRetrieve project statistics, including the total count and, when available, total size. Supports filtering by tags and field criteria using operators such as equal, larger_than, smaller_than, between, and in.

Input Parameters

object
Optionally submit one of the projects attributes in order to filter by them. 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’}). Common filterable fields include: user_id, created_by_user_id, updated_by_user_id, group_id, account_id. Example: {‘user_id’: {‘equal’: 42}} or {‘created_by_user_id’: {‘larger_than’: 100}}.
integer
Optionally submit a tag ID in order to only see projects tagged with the submitted tag.
string
Optionally submit a tag name in order to only see projects tagged with the submitted tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_TASKTool to retrieve details of a specific task by its ID. Use when you have a task ID and need its details.

Input Parameters

string
required
Unique identifier of the task to retrieve
string
Comma-separated list of computed methods to include. Possible option: ‘responsible_user_natural_name’.
string
Space-separated list of related objects to include. Possible values: ‘user’, ‘comments’. Use ‘all’ to include everything.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_USERTool to retrieve the current API user’s details. Use when you need information about the authenticated user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_GET_USER_BY_IDTool to retrieve details of a specific user by ID. Use when you need to fetch information about a particular user from CentralStationCRM.

Input Parameters

string
required
The unique ID of the user to retrieve. Must be a valid user identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_ACTIVITIESRetrieve a paginated list of activities in CentralStationCRM, with optional filtering by person, company, deal, project, user, or account.

Input Parameters

integer
Retrieve records of the given page.
string ("id-asc" | "id-desc")
Ordering options for activity results.
object
Filter activities by attributes. Example: {‘user_id’: {‘equal’: 42}}. Allowed modifiers: ‘smaller_than’, ‘larger_than’, ‘equal’, ‘between’, ‘in’.
integer
Optional ID of the desired deal activities.
string
Possible methods are: ‘attachable’, ‘responsible_user_natural_name’ separated by space. Use ‘all’ to receive all methods.
integer
Elements per page, maximum of 250.
integer
ID of the desired user activities.
string
Possible includes are: ‘user’, ‘activity_receivers’ separated by space. Use ‘all’ to receive all includes.
integer
ID of the desired person activities.
integer
ID of the desired account activities.
integer
Optional ID of the desired company activities.
integer
Optional ID of the desired project activities.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_ATTACHMENTSRetrieve a paginated list of attachments from CentralStationCRM for browsing.

Input Parameters

integer
Page number to retrieve (>=1).
string ("id-asc" | "id-desc")
Ordering options for attachment list.
string
Additional methods to include in the response. Possible values: ‘responsible_user_natural_name’, ‘attachment_category_name’ (space-separated). Use ‘all’ to receive all methods.
integer
Number of elements per page (maximum 250).
string
Additional related data to include in the response. Possible values: ‘user’, ‘attachment_category’, ‘comments’ (space-separated). Use ‘all’ to receive all includes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_AVATARSTool to retrieve all avatars from CentralStationCRM. Use when you need to list all avatars in the system with pagination support.

Input Parameters

integer
Page number to retrieve (>=1).
string ("id-asc" | "id-desc")
Order options for listing avatars.
integer
Number of avatars per page (maximum 250).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_CAL_EVENTSList a page of calendar events from the account, with optional filtering by date, state, or attributes. Supports pagination and includes for related data.

Input Parameters

integer
Retrieve records of the given page.
string
Date formatted YYYY-MM-DD to return only CalEvents after this date.
string ("id-asc" | "id-desc")
Ordering options for cal events.
string ("upcoming" | "old")
State filter for cal events.
string
Date formatted YYYY-MM-DD to return only CalEvents before this date.
object
Filter by calevents attributes. Allowed modifiers: smaller_than, larger_than, equal, between (2 comma-separated values), in (comma-separated list).
integer
Elements per page, maximum of 250.
string
Space-separated includes: user, group_calendar, people, users, cal_event_attendees, comments. Use ‘all’ for all includes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_CAL_EVENTS_CAL_EVENT_ATTENDEESList a page of attendees for a specific calendar event, with pagination and optional ordering and related-data includes.

Input Parameters

integer
Page number to retrieve
string ("id-asc" | "id-desc")
Ordering of records by ID: ‘id-asc’ for ascending, ‘id-desc’ for descending
integer
Number of elements per page, maximum of 250
string
Related objects to include in the response. Possible values: ‘user’, ‘person’, ‘cal_event’ (space-separated). Use ‘all’ to receive all includes.
string
required
Unique identifier of the calendar event to retrieve attendees for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_COMMENTSList a page of comments from the account, with pagination and ordering support.

Input Parameters

integer
Page number to retrieve (>=1)
string ("id-asc" | "id-desc")
Ordering options for comment retrieval.
string
Additional methods to include. Possible option: ‘responsible_user_natural_name’
integer
Number of comments per page (maximum 250)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_COMPANIESTool to retrieve a paginated list of all companies from CentralStationCRM. Use when you need to browse or search through companies with filtering and pagination support.

Input Parameters

integer
Retrieve records of the given page
string ("abc-asc" | "abc-desc" | "new-asc" | "new-desc" | "update-asc" | "update-desc")
Order options for company listing.
object
Filter by company attributes using modifiers: smaller_than, larger_than, equal, between (expects two comma-separated values), or in (expects comma-separated list). Example: {‘user_id’: {‘equal’: 42}}
integer
Optionally submit a tag ID to filter companies tagged with the submitted tag
string
Additional methods to include. Options: responsible_user_natural_name, related_tasks, stream_updated_at, absolute_url (space-separated). Use ‘all’ to receive all methods.
integer
Elements per page, maximum of 250
string
Additional related data to include. Options: positions, deals, projects, tags, tasks, pending_tasks, cal_events, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, connections, custom_fields (space-separated). Use ‘all’ to receive all includes.
string
Optionally submit a tag name to filter companies tagged with the submitted tag
string
Filter companies with activities within the stream later than the submitted point in time (ISO 8601 date or timestamp)
string
Filter companies with activities within the stream earlier than the submitted point in time (ISO 8601 date or timestamp)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_COMPANIES_ADDRSList a page of addresses for a specific company by its ID, with pagination and ordering support.

Input Parameters

integer
Retrieve records of the given page
string
Ordering of records using one of the following order options: id-asc, id-desc
integer
Elements per page, maximum of 250
integer
required
ID of the company the contact details belong to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_COMPANIES_AVATARSList avatars for a specific company. Results are paginated; request additional pages to retrieve the full list.

Input Parameters

integer
Retrieve records of the given page
integer
Elements per page, maximum of 250
string
required
Unique identifier of the company whose avatars are to be retrieved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_COMPANIES_CONTACT_DETAILSList contact details for a specific company. Results are paginated; request additional pages to retrieve the full list.

Input Parameters

integer
Retrieve records of the given page
string
Ordering of records using one of the following order options: id-asc, id-desc
integer
Elements per page, maximum of 250
integer
required
ID of the company the contact details belong to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_COMPANIES_EXTERNAL_EMAILSList external emails associated with a specific company in CentralStationCRM. Results are paginated; request additional pages to retrieve the full list.

Input Parameters

integer
Retrieve records of the given page
integer
Elements per page, maximum of 250
string
Additional related data to include. Possible option: comments
integer
required
ID of the company whose external emails are to be retrieved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_COMPANIES_PROTOCOLS_ATTACHMENTSList attachments for a specific protocol within a company. Results are paginated; request additional pages to retrieve the full list.

Input Parameters

integer
Page number to retrieve (>=1).
string
Additional methods to include in the response. Possible values: ‘responsible_user_natural_name’, ‘attachment_category_name’ (space-separated). Use ‘all’ to receive all methods.
integer
Number of elements per page (maximum 250).
string
Additional related data to include in the response. Possible values: ‘user’, ‘attachment_category’, ‘comments’ (space-separated). Use ‘all’ to receive all includes.
integer
required
ID of the company the protocol belongs to.
integer
required
ID of the protocol to retrieve attachments from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_CUSTOM_FIELDS_TYPESList an account’s custom field types, with pagination and optional ID ordering.

Input Parameters

integer
Retrieve records of the given page
string ("id-asc" | "id-desc")
Order options for custom field types listing.
integer
Elements per page, maximum of 250

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_DEALSList deals with pagination, sorting, and filters such as tags, date ranges, and deal attributes.

Input Parameters

integer
Page number to retrieve (>=1).
string ("date-asc" | "date-desc" | "new-asc" | "new-desc" | "update-asc" | "update-desc" | "value-asc" | "value-desc" | "state-asc" | "state-desc" | "abc-asc" | "abc-desc")
Ordering options for deal listings.
object
Filter by deal attributes using modifiers: ‘smaller_than’, ‘larger_than’, ‘equal’, ‘between’ (expects two comma-separated values), or ‘in’ (expects comma-separated list). Example: {‘user_id’: {‘equal’: 42}}
integer
Filter deals by tag ID - only returns deals tagged with the submitted tag.
string
Comma or space-separated list of methods: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at. Use ‘all’ to receive all methods.
integer
Number of deals per page, maximum of 250.
string
Comma or space-separated list of includes: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields. Use ‘all’ to receive all includes.
string
Filter deals by tag name - only returns deals tagged with the submitted tag.
string
Filter deals with activities within the stream later than the submitted date or timestamp (ISO 8601 format).
string
Filter deals with activities within the stream earlier than the submitted date or timestamp (ISO 8601 format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_DEALS_EXTERNAL_EMAILSList external emails associated with a specific deal, with pagination and optional ordering.

Input Parameters

integer
Retrieve records of the given page
string ("id-asc" | "id-desc")
Enum for ordering options for external emails.
integer
required
ID of the deal whose external emails are to be retrieved
integer
Elements per page, maximum of 250
string
Additional related data to include. Possible option: comments

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_DEALS_PROTOCOLS_ATTACHMENTSList attachments for a specific protocol within a deal, with optional pagination.

Input Parameters

integer
Page number to retrieve (>=1).
string ("id-asc" | "id-desc")
Ordering options for attachment list.
integer
required
ID of the deal the protocol belongs to.
string
Additional methods to include in the response. Possible values: ‘responsible_user_natural_name’, ‘attachment_category_name’ (space-separated). Use ‘all’ to receive all methods.
integer
Number of elements per page (maximum 250).
string
Additional related data to include in the response. Possible values: ‘user’, ‘attachment_category’, ‘comments’ (space-separated). Use ‘all’ to receive all includes.
integer
required
ID of the protocol to retrieve attachments from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_EXTERNAL_EMAILSList external emails from CentralStationCRM with optional pagination, ordering, and inclusion of comments.

Input Parameters

integer
Retrieve records of the given page
string ("id-asc" | "id-desc")
Order options for external emails listing.
integer
Elements per page, maximum of 250
string
Additional related data to include. Possible option: comments

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_FILTER_GROUPSList CentralStationCRM filter groups with pagination, ordering, and filtering support.

Input Parameters

integer
Retrieve records of the given page
string ("abc-asc" | "abc-desc" | "new-asc" | "new-desc" | "update-asc" | "update-desc" | "activity-asc" | "activity-desc")
Order options for filter group listing.
object
Filter by filter group attributes using modifiers: smaller_than, larger_than, equal, between (expects two comma-separated values like ‘2023-01-01,2023-02-01’), or in (expects comma-separated list like ‘23,42,99’). Example: {‘user_id’: {‘equal’: 42}}
integer
Elements per page, maximum of 250

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_GROUP_CALENDARSList group calendars from the account with optional pagination and includes for related calendar events.

Input Parameters

integer
Retrieve records of the given page.
string ("id-asc" | "id-desc")
Ordering options for group calendars.
integer
Elements per page, maximum of 250.
string
Additional related data to include. Possible option: ‘cal_events’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_HISTORIC_EVENTSList historic events from the CentralStationCRM account with optional filtering and pagination.

Input Parameters

integer
Page number to retrieve (>=1).
string ("id-asc" | "id-desc")
Ordering options for historic events.
object
Filter by historic event attributes. Use modifiers like ‘equal’, ‘smaller_than’, ‘larger_than’, ‘between’ (expects two comma-separated values), or ‘in’ (expects comma-separated list). Example: {‘user_id’: {‘equal’: 42}} or {‘created_at’: {‘between’: ‘2023-01-01,2023-02-01’}}.
string
Filter historic events up to this date (format: YYYY-MM-DD). Must be used together with date_from parameter.
integer
Number of elements per page (maximum 250).
string
Filter historic events from this date onwards (format: YYYY-MM-DD). Must be used together with date_to parameter.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_HOOKSList and inspect the account’s webhook configurations with optional pagination.

Input Parameters

integer
Retrieve records of the given page
integer
Elements per page, maximum of 250
string
Additional related data to include. Possible option: filter_groups

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_PEOPLETool to retrieve a paginated list of all people from CentralStationCRM. Use when you need to browse or search through people with filtering and pagination support.

Input Parameters

integer
Retrieve records of the given page
string ("abc-asc" | "abc-desc" | "new-asc" | "new-desc" | "update-asc" | "update-desc")
Order options for people listing.
object
Optionally submit one of the people attributes in order to filter by them. Allowed filter modifiers are: smaller_than, larger_than, equal, between (expects two comma-separated values), or in (expects comma-separated list). Example: {‘name’: {‘equal’: ‘John Doe’}} or {‘user_id’: {‘equal’: 42}}
integer
Optionally submit a tag ID in order to only see people tagged with the submitted tag
string
Additional methods to include. Options: responsible_user_natural_name, salutation_official, salutation_formal, salutation_informal, backlink, stream_updated_at, absolute_url, absolute_avatar_url (space-separated). Use ‘all’ to receive all methods.
integer
Elements per page, maximum of 250
string
Additional related data to include. Options: positions, companies, deals, projects, tags, tasks, tasks_pending, pending_tasks, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, addrs_from_company, custom_fields, historic_events, assis, connections, user (space-separated). Use ‘all’ to receive all includes.
string
Optionally submit a tag name in order to only see people tagged with the submitted tag
string
Optionally submit one or multiple custom field types to filter by their value. This shall be formatted like custom_fields[custom_field_type_id]=value
string
Optionally submit a date or timestamp (ISO 8601) in order to only see people with activities within the stream later than the submitted point in time.
string
Optionally submit a date or timestamp (ISO 8601) in order to only see people with activities within the stream earlier than the submitted point in time.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_PEOPLE_ASSISList assistant contacts associated with a specific person by ID, with pagination and ordering support.

Input Parameters

integer
Retrieve records of the given page
string ("id-asc" | "id-desc")
Ordering options for assis results.
integer
Elements per page, maximum of 250
integer
required
ID of the person the assi belong to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_PEOPLE_AVATARSTool to retrieve all avatars for a specific person. Use when you need to list a person’s avatar images with pagination support.

Input Parameters

integer
Page number to retrieve (>=1).
integer
Number of avatars per page (maximum 250).
string
required
Unique identifier of the person whose avatars are to be retrieved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_PEOPLE_CONTACT_DETAILSList contact details for a specific person by ID, with pagination and ordering support.

Input Parameters

integer
Retrieve records of the given page
string ("id-asc" | "id-desc")
Ordering options for contact details.
integer
Elements per page, maximum of 250
integer
required
ID of the person the contact details belong to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_PEOPLE_CUSTOM_FIELDSList custom fields for a specific person by ID from the dedicated custom fields endpoint, with pagination support.

Input Parameters

integer
Retrieve records of the given page
string ("id-asc" | "id-desc")
Ordering options for custom fields list.
integer
Elements per page, maximum of 250
string
Possible option: custom_fields_type
integer
required
ID of the person whose custom fields are to be retrieved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_PEOPLE_EXTERNAL_EMAILSList external email communications associated with a specific person in CentralStationCRM, with pagination support.

Input Parameters

integer
Retrieve records of the given page
string ("id-asc" | "id-desc")
Order options for listing external emails.
integer
Elements per page, maximum of 250
string
Additional related data to include. Possible option: comments
integer
required
ID of the person whose external emails are to be retrieved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_PEOPLE_HISTORIC_EVENTSList historic events for a specific person, including recorded milestone dates such as birthdays and anniversaries, with pagination support.

Input Parameters

integer
Retrieve records of the given page
string ("id-asc" | "id-desc")
Order options for listing historic events.
integer
Elements per page, maximum of 250
integer
required
ID of the person the historic event belong to

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_PEOPLE_POSITIONSList job positions or company affiliations for a specific person. Results are paginated; request additional pages to retrieve the full list.

Input Parameters

integer
Page number to retrieve
string ("id-asc" | "id-desc")
Order options for listing positions.
integer
Number of entries per page (maximum 250)
string
Space-separated list of related objects to include. Possible includes: ‘person’, ‘company’. Use ‘all’ to receive all includes
integer
required
Unique identifier of the person whose positions are to be retrieved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_PEOPLE_PROTOCOLS_ATTACHMENTSList attachments for a specific protocol within a person. Results are paginated; request additional pages to retrieve the full list.

Input Parameters

integer
Page number to retrieve (>=1).
string ("id-asc" | "id-desc")
Ordering options for attachment list.
string
Additional methods to include in the response. Possible values: ‘responsible_user_natural_name’, ‘attachment_category_name’ (space-separated). Use ‘all’ to receive all methods.
integer
Number of elements per page (maximum 250).
string
Additional related data to include in the response. Possible values: ‘user’, ‘attachment_category’, ‘comments’ (space-separated). Use ‘all’ to receive all includes.
integer
required
ID of the person the protocol belongs to.
integer
required
ID of the protocol to retrieve attachments from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_PEOPLE_TAGSList tags for a specific person. Results are paginated; request additional pages to retrieve the full list.

Input Parameters

integer
Page number to retrieve (>=1)
integer
Number of entries per page (maximum 250)
integer
required
Unique identifier of the person whose tags are to be retrieved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_PROJECTSTool to retrieve a paginated list of all projects from CentralStationCRM. Use when you need to browse or search through projects with filtering and pagination support.

Input Parameters

integer
Retrieve records of the given page
string ("date-asc" | "date-desc" | "new-asc" | "new-desc" | "update-asc" | "update-desc" | "state-asc" | "state-desc" | "abc-asc" | "abc-desc")
Order options for project listing.
object
Filter by project attributes using modifiers: smaller_than, larger_than, equal, between (expects two comma-separated values), or in (expects comma-separated list). Example: {‘user_id’: {‘equal’: 42}}
integer
Optionally submit a tag ID to filter projects tagged with the submitted tag
string
Additional methods to include. Options: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at (space-separated). Use ‘all’ to receive all methods.
integer
Elements per page, maximum of 250
string
Additional related data to include. Options: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields (space-separated). Use ‘all’ to receive all includes.
string
Optionally submit a tag name to filter projects tagged with the submitted tag
string
Filter projects with activities within the stream later than the submitted point in time (ISO 8601 date or timestamp)
string
Filter projects with activities within the stream earlier than the submitted point in time (ISO 8601 date or timestamp)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_PROJECTS_EXTERNAL_EMAILSRetrieve a page of external emails associated with a specific CentralStationCRM project, with pagination and ordering support.

Input Parameters

integer
Retrieve records of the given page
string ("id-asc" | "id-desc")
Ordering options for external emails.
integer
Elements per page, maximum of 250
string
Additional related data to include. Possible option: comments
integer
required
ID of the project whose external emails are to be retrieved

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_PROJECTS_PROTOCOLS_ATTACHMENTSRetrieve a page of attachments associated with a specific protocol within a project, with pagination and ordering support.

Input Parameters

integer
Page number to retrieve (>=1).
string ("id-asc" | "id-desc")
Ordering options for attachment list.
string
Additional methods to include in the response. Possible values: ‘responsible_user_natural_name’, ‘attachment_category_name’ (space-separated). Use ‘all’ to receive all methods.
integer
Number of elements per page (maximum 250).
string
Additional related data to include in the response. Possible values: ‘user’, ‘attachment_category’, ‘comments’ (space-separated). Use ‘all’ to receive all includes.
integer
required
ID of the project the protocol belongs to.
integer
required
ID of the protocol to retrieve attachments from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_PROTOCOLSList a page of protocols from CentralStationCRM, optionally filtering by person, company, deal, or project.

Input Parameters

integer
Retrieve records of the given page
string ("id-asc" | "id-desc")
Ordering options for protocols.
integer
Optional ID of the desired deal protocols
string
Possible methods are: responsible_user_natural_name, absolute_url, conversion_step_names separated by space. Receive all methods using the ‘all’ value.
integer
Elements per page, maximum of 250
string
Possible option: comments
integer
Optional ID of the desired person
integer
Optional ID of the desired company protocols
integer
Optional ID of the desired project protocols

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_PROTOCOLS_ATTACHMENTSList a page of attachments associated with a specific protocol.

Input Parameters

integer
Page number to retrieve (>=1).
string ("id-asc" | "id-desc")
Ordering options for attachment list.
string
Additional methods to include in the response. Possible values: ‘responsible_user_natural_name’, ‘attachment_category_name’ (space-separated). Use ‘all’ to receive all methods.
integer
Number of elements per page (maximum 250).
string
Additional related data to include in the response. Possible values: ‘user’, ‘attachment_category’, ‘comments’ (space-separated). Use ‘all’ to receive all includes.
integer
required
ID of the protocol to retrieve attachments from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_TAGSList a page of tags from CentralStationCRM, optionally filtering by person, company, deal, or project.

Input Parameters

integer
Retrieve records of the given page
string ("id-asc" | "id-desc")
Order options for tag listing.
object
Filter by tag attributes using modifiers: smaller_than, larger_than, equal, between (expects two comma-separated values like ‘2023-01-01,2023-02-01’), or in (expects comma-separated list like ‘23,42,99’). Example: {‘user_id’: {‘equal’: 42}}
integer
Optional ID of the desired deal to filter tags by
integer
Elements per page, maximum of 250
integer
Optional ID of the desired person to filter tags by
integer
Optional ID of the desired company to filter tags by
integer
Optional ID of the desired project to filter tags by

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_TAGS2Tool to retrieve all tag names from CentralStationCRM. Use when you need a simple list of tag names (strings) with pagination support.

Input Parameters

integer
Retrieve records of the given page
integer
Elements per page, maximum of 250

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_TASKSTool to retrieve a paginated list of all tasks from CentralStationCRM. Use when you need to browse or search through tasks with filtering and pagination support.

Input Parameters

integer
Retrieve records of the given page
string
Filter tasks with dates after this date. Format: YYYY-MM-DD
string ("id-asc" | "id-desc")
Order options for task listing.
string ("open" | "closed")
State filter options for tasks.
string
Filter tasks with dates before this date. Format: YYYY-MM-DD
string
Additional methods to include. Option: responsible_user_natural_name
integer
Elements per page, maximum of 250
string
Filter tasks by user ID
string
Additional related data to include. Options: user, comments (space-separated). Use ‘all’ to receive all includes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_LIST_USERSTool to retrieve all users of the account from CentralStationCRM. Use when you need to list system users with pagination support.

Input Parameters

integer
Retrieve records of the given page
string
Optional parameter to only include currently active users. Set to “true” to filter active users.
integer
Elements per page, maximum of 250

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_MERGE_COMPANIESTool to merge multiple companies into an existing company by ID. Use after identifying duplicate company records to consolidate them.

Input Parameters

boolean
Set to true if you don’t want to generate an activity for the stream
integer
Optional. New group ID to assign the merged company
integer
required
ID of the winner company that other companies will be merged into
array
required
List of company IDs to merge into the winner company

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_MERGE_PERSONTool to merge another person into an existing person by ID. Use after identifying duplicate records to consolidate them. Example: merge person 42 with [43,44].

Input Parameters

boolean
Suppress creation of an activity log entry when merging
integer
Optional. New group ID to assign the merged person
integer
required
ID of the existing person into whom others will be merged
array
required
List of person IDs to merge into the target person

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_SEARCH_ATTACHMENTSSearch for attachments in CentralStationCRM by filename. Returns a list of attachments with their metadata including file details, timestamps, and optional related data such as user, category, and comments. Use when you need to find specific files or documents attached to CRM records.

Input Parameters

integer
Page number to retrieve. Must be >= 1.
string
Possible methods are: responsible_user_natural_name, attachment_category_name separated by space. Receive all methods using the ‘all’ value.
integer
Number of entries per page, maximum of 250. Must be between 1 and 250.
string
Find attachments where the filename includes or matches the given input. Supports partial matching.
string
Possible includes are: user, attachment_category, comments separated by space. Receive all includes using the ‘all’ value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_SEARCH_COMPANIESSearch for companies in CentralStationCRM by name, with pagination support.

Input Parameters

string
required
Retrieve companies by their name. Performs a search match. This parameter is required.
integer
Retrieve records of the given page. Must be >= 1.
string
Space-separated list of methods to invoke. Possible values: responsible_user_natural_name, related_tasks, stream_updated_at, absolute_url. Use ‘all’ to invoke all methods.
integer
Elements per page, maximum of 250. Must be between 1 and 250.
string
Space-separated list of related data to include. Possible values: positions, deals, projects, tags, tasks, pending_tasks, cal_events, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, connections, custom_fields. Use ‘all’ to include everything.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_SEARCH_COMPANIES_PROTOCOLS_ATTACHMENTSTool to search for attachments within a specific protocol of a company. Use when you need to find specific attachments by filename within a company’s protocol.

Input Parameters

integer
Page number to retrieve. Must be >= 1.
string
Additional methods to include in the response. Possible values: ‘responsible_user_natural_name’, ‘attachment_category_name’ (space-separated). Use ‘all’ to receive all methods.
integer
Number of entries per page, maximum of 250. Must be between 1 and 250.
string
Find attachments where the filename includes or matches the given input. Supports partial matching.
string
Additional related data to include in the response. Possible values: ‘user’, ‘attachment_category’, ‘comments’ (space-separated). Use ‘all’ to receive all includes.
integer
required
ID of the company the protocol belongs to.
integer
required
ID of the protocol to search attachments in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_SEARCH_CONTACT_DETAILSSearch for contact details in CentralStationCRM by name, email, phone, or other contact information, optionally selecting people or companies. A non-list API response is returned as an empty results list.

Input Parameters

string
required
Search term to match contact details. Searches across email addresses, phone numbers, and other contact information.
integer
Page number to retrieve (1-indexed). Must be >= 1.
string ("people" | "companies")
Contact type for search.
integer
Number of results per page. Maximum of 250. Must be between 1 and 250.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_SEARCH_DEALSSearch CentralStationCRM deals by name, including partial matches, and retrieve paginated results. You can request related objects and additional deal information; pages contain at most 250 deals.

Input Parameters

string
Retrieve deals by their name (partial match supported).
integer
Retrieve records of the given page.
string
Possible methods are: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at separated by space. Receive all methods using the ‘all’ value.
integer
Elements per page, maximum of 250.
string
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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_SEARCH_DEALS_PROTOCOLS_ATTACHMENTSSearch attachments within a specific deal protocol by filename, with optional pagination and related data. A non-list API response is returned as an empty attachment list.

Input Parameters

integer
Page number to retrieve. Must be >= 1.
integer
required
Unique identifier of the deal to search attachments in.
string
Possible methods are: responsible_user_natural_name, attachment_category_name separated by space. Receive all methods using the ‘all’ value.
integer
Number of entries per page, maximum of 250. Must be between 1 and 250.
string
Find attachments where the filename includes or matches the given input. Supports partial matching.
string
Possible includes are: user, attachment_category, comments separated by space. Receive all includes using the ‘all’ value.
integer
required
Unique identifier of the protocol within the deal to search attachments in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_SEARCH_PEOPLERequest a page of people from CentralStationCRM, optionally submitting a text query and page parameters. Results contain the person fields returned through the tool’s response schema.

Input Parameters

integer
1-indexed page number of results, must be >= 1.
string
Text to search for in name, email, phone, etc.
integer
Number of results per page, must be >= 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_SEARCH_PEOPLE_PROTOCOLS_ATTACHMENTSTool to search for attachments within a specific person protocol in CentralStationCRM. Returns a list of attachments matching the search criteria with their metadata including file details, timestamps, and optional related data such as user, category, and comments. Use when you need to find specific files or documents attached to a person protocol.

Input Parameters

integer
Page number to retrieve. Must be >= 1.
string
Possible methods are: responsible_user_natural_name, attachment_category_name separated by space. Receive all methods using the ‘all’ value.
integer
Number of entries per page, maximum of 250. Must be between 1 and 250.
string
Find attachments where the filename includes or matches the given input. Supports partial matching.
string
Possible includes are: user, attachment_category, comments separated by space. Receive all includes using the ‘all’ value.
integer
required
Unique identifier of the person to search attachments in.
integer
required
Unique identifier of the protocol within the person to search attachments in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_SEARCH_PEOPLE_V2Search for people in CentralStationCRM by last name, first name, email address, or phone number. Supports pagination.

Input Parameters

string
Search people by their last name
integer
Retrieve records of the given page
string
Search people by their email address (mutually exclusive with phone)
string
Search people by their phone number (mutually exclusive with email)
string
Additional methods to call. Possible values: responsible_user_natural_name, salutation_official, salutation_formal, salutation_informal, backlink, stream_updated_at, absolute_url, absolute_avatar_url separated by space. Use ‘all’ to receive all methods.
integer
Elements per page, maximum of 250
string
Additional data to include. Possible values: positions, companies, deals, projects, tags, tasks, tasks_pending, pending_tasks, upcoming_cal_events, tels, emails, ims, sms, homepages, addrs, addrs_from_company, custom_fields, historic_events, assis, connections, user separated by space. Use ‘all’ to receive all includes.
string
Search people by their first name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_SEARCH_PROJECTSTool to search for projects in CentralStationCRM by name. Use when you need to find projects matching a specific name or retrieve a list of all projects with pagination support.

Input Parameters

string
Retrieve projects by their name (partial match supported).
integer
Retrieve records of the given page. Must be >= 1.
string
Space-separated list of methods to invoke. Possible values: responsible_user_natural_name, people_ids, absolute_url, stream_updated_at. Use ‘all’ to invoke all methods.
integer
Elements per page, maximum of 250. Must be between 1 and 250.
string
Space-separated list of related data to include. Possible values: tags, people, company, task_lists, tasks, pending_tasks, cal_events, upcoming_cal_events, custom_fields. Use ‘all’ to include everything.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_SEARCH_PROJECTS_PROTOCOLS_ATTACHMENTSTool to search for attachments within a specific protocol of a project. Use when you need to find specific attachments by filename within a project’s protocol.

Input Parameters

integer
Page number to retrieve. Must be >= 1.
string
Additional methods to include in the response. Possible values: ‘responsible_user_natural_name’, ‘attachment_category_name’ (space-separated). Use ‘all’ to receive all methods.
integer
Number of entries per page, maximum of 250. Must be between 1 and 250.
string
Find attachments where the filename includes or matches the given input. Supports partial matching.
string
Additional related data to include in the response. Possible values: ‘user’, ‘attachment_category’, ‘comments’ (space-separated). Use ‘all’ to receive all includes.
integer
required
ID of the project the protocol belongs to.
integer
required
ID of the protocol to search attachments in.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_SEARCH_RECORDSTool to retrieve search results from CentralStationCRM. Use when you need to search for records using a search term.

Input Parameters

integer
Page number to retrieve. Must be >= 1.
string
required
Search term to query records. This parameter is required. The API will return an error if the search term is missing.
integer
Number of entries per page, maximum of 250. Must be between 1 and 250.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_SEARCH_USERSTool to search for users in CentralStationCRM by first name or last name. Use when you need to find users matching specific name criteria or retrieve a list of all users with pagination support.

Input Parameters

string
Retrieve users by their last name. Performs a search match.
integer
Retrieve records of the given page. Must be >= 1.
string
Retrieve users by their first name. Performs a search match.
integer
Elements per page, maximum of 250. Must be between 1 and 250.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_STATS_PEOPLERetrieve statistics about people (contacts) in your CRM. Returns the total count of people matching the specified criteria. Use this when you need a quick count without fetching full person records. Supports filtering by tags and various field criteria (user_id, created_by_user_id, account_id, group_id, etc.) using operators like ‘equal’, ‘larger_than’, ‘smaller_than’, and ‘between’.

Input Parameters

object
Filter criteria in deepObject style. Supports operators: ‘equal’, ‘smaller_than’, ‘larger_than’, ‘between’. Common filterable fields include: user_id, created_by_user_id, updated_by_user_id, group_id, account_id. Example: {‘user_id’: {‘equal’: 42}} or {‘created_by_user_id’: {‘larger_than’: 100}}.
integer
Filter statistics by this tag’s ID.
string
Filter statistics by this tag’s name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_CAL_EVENTUpdate an existing calendar event by ID, including its name, time, status, and other event details. The event owner, group calendar, name, start and end times, and status are required.

Input Parameters

string
required
UUID of the calendar event to update
boolean
Set to true if you don’t want to generate an activity for the stream
object
required
Calendar event details to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_CAL_EVENT_ATTENDEEUpdate a calendar event attendee by event and attendee ID. A status is required, with optional email and associated person or user changes.

Input Parameters

string
required
Unique identifier of the calendar event attendee to update
string
Email address of the attending person or user. Invitations will be sent to this address if email_notifications is set to true for the related cal event
string ("new" | "invited" | "no_invite" | "accepted" | "rejected" | "perhaps" | "canceled")
required
Status of the attendee. Can be new, invited, no_invite, accepted, rejected, perhaps or canceled
integer
ID of the related CSCRM user. Either person_id or user_id has to be set to valid records
integer
ID of the related CSCRM person. Either person_id or user_id has to be set to valid records
string
required
Unique identifier of the calendar event

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_COMMENTUpdate an existing comment by ID. The updated text is required, with optional changes to its associated entity or user.

Input Parameters

string
required
The unique identifier of the comment to update
string
required
The updated text content of the comment
integer
ID of the user associated with this comment
string
ID of the entity this comment is attached to
string ("Attachment" | "CalEvent" | "Protocol" | "ExternalEmail" | "Task")
Types of entities a comment can be attached to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_COMPANYUpdate a company by ID, supplying its name and optionally its group, responsible user, or background. If the successful response body is empty, the returned company data is constructed from the request.

Input Parameters

string
required
The company’s name
boolean
Set to true if you don’t want to generate an activity in the stream
integer
Optional ID of the user responsible for the company
integer
Optional ID of the group to assign the company to
string
Optional background or description of the company
integer
required
The unique identifier of the company to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_COMPANY_ADDRESSTool to update a specific address of a company. Use after retrieving the company’s addresses to modify one.

Input Parameters

integer
required
ID of the address to update
string
The zip code
string
The city name. Either the city or the country_code is mandatory
string ("work_hq" | "work" | "invoice" | "delivery" | "private" | "other")
required
Type of address. Must be one of work_hq, work, invoice, delivery, private or other
string
The street including the house number or other details (building, c/o)
boolean
Decides about the order of addresses when the attachable (Person or Company) has multiple addresses
boolean
States whether or not the address has been added via the API or some sort of integration
integer
required
ID of the company the address belongs to
string
The state code (e.g. NW, BY). Must match the country code
string
The country code (e.g. DE, AT)
integer
required
The ID of the record the address belongs to. Will be auto set when using routes such as /companies/:id with nested attributes
string
required
The record type the address belongs to. Must be either Person or Company. Will be auto set when using routes such as /companies/:id with nested attributes

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_COMPANY_CONTACT_DETAILTool to update a contact detail for a company by ID. Use after retrieving the company’s contact details to modify one.

Input Parameters

integer
required
ID of the contact detail to update
string
required
The value of the contact detail according to the selected type.
string ("office" | "office_hq" | "mobile" | "fax" | "private" | "voip" | "skype" | "other")
required
Phone type. Must be one of office, office_hq, mobile, fax, private, voip, skype or other.
integer
required
ID of the company the contact details belong to
integer
required
The ID of the record the contact detail belongs to.
string ("Person" | "Company")
required
The record type the contact detail belongs to. Must be either Person or Company.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_CUSTOM_FIELDS_TYPEUpdate a custom field type by ID. The update requires its category, data type, name, and position, and can include options.

Input Parameters

string
required
The unique identifier of the custom field type to update
object
required
The custom field type data to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_DEALTool to update an existing deal record. Use when you need to modify deal details like background, state, value, or associated entities.

Input Parameters

integer
required
Unique identifier of the deal to update
string
Name of the deal (max 120 chars)
string
Monetary value of the deal in decimal format
boolean
Set to true if you don’t want to generate an activity for the stream
integer
User ID responsible for this deal
string
Currency code (EUR, CHF, or USD). Default is EUR
integer
Group ID for the deal
string
Total sum of the deal value (value * value_count depending on value_type). Must be in decimal format.
string
Details about the deal, e.g., history or notes
integer
Company ID to associate with the deal
string ("total" | "monthly" | "hourly" | "daily")
Type of billing: total, monthly, hourly, or daily
string
Date-time when the deal was set to won or lost (ISO8601 format)
integer
Probability of winning the deal in percent (0-100)
string
Target date when the deal shall be won in YYYY-MM-DD format
string
Quantity or count; only relevant if value_type is not ‘total’. Must be in decimal format.
integer
ID of the pipeline for this deal
string ("open_0" | "open_25" | "open_50" | "open_75" | "won" | "lost")
State of the deal: open_0, open_25, open_50, open_75, won, or lost
integer
ID of the stage within the pipeline

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_GROUP_CALENDARSUpdate an existing group calendar by ID, supplying its name, color, and read-only status.

Input Parameters

string
required
Unique identifier (UUID) of the group calendar to update
object
required
Group calendar object containing the fields to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_PEOPLE_CUSTOM_FIELDSTool to update a person’s custom field by its ID. Use when you need to modify a custom field value after confirming the person_id and custom field id.

Input Parameters

integer
required
Unique identifier of the custom field to update. Must be a positive integer.
integer
required
Unique identifier of the person to which the custom field belongs. Must be a positive integer.
object
required
Custom field data to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_PEOPLE_POSITIONTool to update a position for a specific person. Use after retrieving the person’s positions when you need to modify position details such as title, department, or status.

Input Parameters

integer
required
Unique identifier of the position to update
string
Name/title of the position (e.g., ‘Principal Software Engineer’)
boolean
Whether this is a former position (True) or current position (False). Positions that are no longer active may be marked as former
integer
required
Unique identifier of the person whose position is to be updated
integer
required
The ID of the company the position belongs to
string
Department within the company
string
Name of the company associated with this position
boolean
Whether this is the primary function/position. Only one position may be set to primary

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_PERSONUpdate an existing person by ID, including their name, title, gender, background, or responsible user.

Input Parameters

string
The person’s last name (surname)
string
The person’s job title
string
The person’s gender (valid values: ‘male’, ‘female’)
integer
The ID of the user responsible for this person
integer
required
The unique identifier of the person to update
string
Additional background or bio information
string
The person’s first name

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_PERSON_ADDRESSTool to update a specific address of a person. Use after retrieving the person’s addresses to modify one.

Input Parameters

string
ZIP or postal code
string
required
City name. Either city or country_code must be provided
string ("work_hq" | "work" | "invoice" | "delivery" | "private" | "other")
Type of address, one of work_hq, work, invoice, delivery, private or other
string
The street including house number or additional info
boolean
Whether this is the primary address
integer
required
Unique identifier of the person
integer
required
Unique identifier of the address to update
string
State or region code (e.g., NW)
string
ISO 3166-1 alpha-2 country code

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_PERSON_ASSITool to update an assi entry of a person. Use when you need to modify a specific assistant record after retrieving the person’s assis list. Example: “Update assi 101 for person 42 changing email to foo@example.com”.

Input Parameters

string
The telephone number of the assistant.
string
required
The name of the assistant.
string
The email of the assistant.
integer
required
Unique identifier of the assistant to update
boolean
Indicates if the assistant is the primary contact.
integer
required
Unique identifier of the person

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_PERSON_CONTACT_DETAILTool to update a specific contact detail of a person by ID. Use after retrieving the person’s contact details to modify one.

Input Parameters

string
required
The phone number or contact value.
string ("office" | "office_hq" | "mobile" | "fax" | "private" | "voip" | "skype" | "other")
required
Phone type. Must be one of office, office_hq, mobile, fax, private, voip, skype or other.
boolean
Whether this should be the primary contact detail of this type
boolean
Whether this contact detail is visible to other users
integer
required
Unique identifier of the person
integer
ID of the associated location if applicable
integer
required
Unique identifier of the contact detail to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_PERSON_HISTORIC_EVENTTool to update a historic event of a person by ID. Use after retrieving the event when you need to modify its details. Example: “Update historic event 101 for person 42 changing atype to anniversary.”

Input Parameters

string
For atype ‘other’, an additional description may be provided. Ignored otherwise.
string
required
The date of the historic event in YYYY-MM-DD format.
string ("birthday" | "anniversary" | "first_met" | "renewal" | "other")
required
Type of the historic event. Must be one of birthday, anniversary, first_met, renewal or other.
integer
required
Unique identifier of the historic event to update
integer
required
Unique identifier of the person

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_PERSON_TAGTool to update a tag on a person. Use when you need to modify an existing tag’s name or properties for a specific person.

Input Parameters

string
required
The unique identifier of the tag to update
object
required
The tag data to update
integer
required
The unique identifier of the person

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_PROJECTTool to update an existing project record. Use when you need to modify project details like name, target date, state, or associated entities.

Input Parameters

integer
required
Unique identifier of the project to update
string
Name of the project (max 120 chars)
boolean
Set to true if you don’t want to generate an activity for the stream
integer
Deal ID to associate with the project
integer
User ID responsible for this project
integer
Group ID for the project
string
Details about the project, e.g., description or notes
integer
Company ID to associate with the project
string
Date-time when the project was finished (ISO8601 format)
string
Target completion date in YYYY-MM-DD format
string ("open_0" | "open_25" | "open_50" | "open_75" | "won" | "lost")
State of the project: open_0, open_25, open_50, open_75, won, or lost
string
Set of person IDs to associate with the project

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_PROTOCOLUpdate an existing protocol by ID, supplying its content and optionally modifying metadata or associations.

Input Parameters

string
required
The unique identifier of the protocol to update
object
required
The protocol data to update

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: CENTRALSTATIONCRM_UPDATE_TASKUpdate an existing task by ID, supplying its name and responsible user ID. Other task details, including completion status and badge, can also be modified.

Input Parameters

string
required
The unique identifier of the task to update
string
required
The task name or description
string ("task" | "call" | "email" | "visit" | "preparation" | "important")
Valid badge types for tasks.
boolean
Set to true if the precise_time hour and minutes are irrelevant, allowing the task to be done at any time during the day
integer
required
The ID of the user responsible for this task
boolean
Set to true if the task is completed/done
string
Date and time when the task should be done (ISO 8601 format)
integer
ID of the task list the task belongs to (must be within the attachable record)
integer
ID of the record the task belongs to (e.g., a person, company, or deal)
string ("Person" | "Company" | "Deal")
Valid attachable types for tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not