The CentralStationCRM connector lets your AI agent act in each user's CentralStationCRM account. Each user connects their own CentralStationCRM API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 59 tools.
- Tools
- 59
- What they doRead · write · destructive
- 32 · 20 · 732 read20 write7 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the CentralStationCRM connection
In AgentKit > Connections, create a CentralStationCRM connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'centralstationcrm'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize CentralStationCRM:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'centralstationcrm_current_user_get',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "centralstationcrm"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize CentralStationCRM:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="centralstationcrm_current_user_get",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their CentralStationCRM credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolcentralstationcrm_activities_listList the activity stream, optionally for one person, company, deal, project or user.Read-onlyList Activities
List the activity stream, optionally for one person, company, deal, project or user. Returns each activity's type, change, user and time. Use it to see recent changes and history.
Inputs
company_idinteger- Only activities for this company. Example: 234567.
deal_idinteger- Only activities for this deal. Example: 345678.
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: attachable.
orderstring- Sort order. Example: date-desc.
pageinteger- Page number, starting at 1. Example: 1.
perpageinteger- Records per page, up to 250. Example: 50.
person_idinteger- Only activities for this person. Example: 1234567.
project_idinteger- Only activities for this project. Example: 456789.
user_idinteger- Only activities by this user. Example: 12345.
centralstationcrm_calendar_event_getGet one calendar event by ID.Read-onlyGet Calendar Event
Get one calendar event by ID. Returns the event's name, start, end, location, status, description and linked record.
Inputs
calendar_event_idstringrequired- ID of the calendar event. Get it from centralstationcrm_calendar_events_list. Example: 1234567.
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: tags.
centralstationcrm_calendar_events_listList calendar events, with paging, a state filter and a date window.Read-onlyList Calendar Events
List calendar events, with paging, a state filter and a date window. Returns each event's ID, name, start, end, location, status and linked record.
Inputs
afterstring- Only events after this date, YYYY-MM-DD. Example: 2026-01-01.
beforestring- Only events before this date, YYYY-MM-DD. Example: 2026-12-31.
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: attachable.
orderstring- Sort order. Example: date-asc.
pageinteger- Page number, starting at 1. Example: 1.
perpageinteger- Records per page, up to 250. Example: 50.
statestring- Event state filter. Example: upcoming.
centralstationcrm_comments_listList comments on records in the account.Read-onlyList Comments
List comments on records in the account. Returns each comment's ID, text, author and linked record.
Inputs
orderstring- Sort order. Example: date-desc.
pageinteger- Page number, starting at 1. Example: 1.
perpageinteger- Records per page, up to 250. Example: 50.
centralstationcrm_companies_listList companies, with paging, ordering and an optional tag filter.Read-onlyList Companies
List companies, with paging, ordering and an optional tag filter. Returns each company's ID, name, background and owner, plus any includes. Use centralstationcrm_companies_search to find a company by name.
Inputs
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: people tags.
orderstring- Sort order. Example: update-desc.one of
date-ascdate-descnew-ascnew-descupdate-ascupdate-descabc-ascabc-desc pageinteger- Page number, starting at 1. Example: 1.
perpageinteger- Records per page, up to 250. Example: 50.
tag_idinteger- Only companies with this tag ID. Example: 5678.
tag_namestring- Only companies with this tag name. Example: Customer.
centralstationcrm_companies_searchSearch companies by name.Read-onlySearch Companies
Search companies by name. Returns matching companies with ID, name and any includes. Use it to find a company ID.
Inputs
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: people.
namestring- Company name to match. Example: Acme.
pageinteger- Page number, starting at 1. Example: 1.
perpageinteger- Records per page, up to 250. Example: 50.
centralstationcrm_company_getGet one company by ID.Read-onlyGet Company
Get one company by ID. Returns the company's name, background, owner and any includes such as people, addresses and deals. Use centralstationcrm_companies_search to find the ID.
Inputs
company_idintegerrequired- ID of the company. Get it from centralstationcrm_companies_search. Example: 1234567.
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: people addrs tels emails deals.
centralstationcrm_connection_checkCheck that the API key works for this CentralStationCRM account.Read-onlyCheck Connection
Check that the API key works for this CentralStationCRM account. Returns the connection status. Run it first to confirm the connection.
Inputs
This tool takes no inputs.
centralstationcrm_current_user_getGet the CentralStationCRM user the API key belongs to.Read-onlyGet Current User
Get the CentralStationCRM user the API key belongs to. Returns the user's ID, name, email and role. Use centralstationcrm_users_list for every user in the account.
Inputs
This tool takes no inputs.
centralstationcrm_custom_field_types_listList the custom field types defined in the account.Read-onlyList Custom Field Types
List the custom field types defined in the account. Returns each type's ID, name and record type.
Inputs
orderstring- Ordering of records using one of the following order options: `id-asc`, `id-desc`. Example: example.
pageinteger- Page number, starting at 1. Example: 1.
perpageinteger- Records per page, up to 250. Example: 50.
centralstationcrm_deal_getGet one deal by ID.Read-onlyGet Deal
Get one deal by ID. Returns the deal's name, value, currency, state or pipeline stage, target date, owner and any includes. Use centralstationcrm_deals_search to find the ID.
Inputs
deal_idintegerrequired- ID of the deal. Get it from centralstationcrm_deals_search. Example: 1234567.
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: people company tasks tags.
centralstationcrm_deal_type_getGet one deal pipeline with its stages.Read-onlyGet Deal Pipeline
Get one deal pipeline with its stages. Returns the pipeline name and each stage's ID, name and default probability. Use the stage IDs as deal_type_stage_id in centralstationcrm_deal_create.
Inputs
deal_type_idintegerrequired- ID of the deal pipeline. Get it from centralstationcrm_deal_types_list. Example: 1234567.
centralstationcrm_deal_types_listList the deal pipelines (deal types) in the account.Read-onlyList Deal Pipelines
List the deal pipelines (deal types) in the account. Returns each pipeline's ID and name. Use centralstationcrm_deal_type_get for a pipeline's stages.
Inputs
This tool takes no inputs.
centralstationcrm_deals_listList deals, with paging, ordering and an optional tag filter.Read-onlyList Deals
List deals, with paging, ordering and an optional tag filter. Returns each deal's ID, name, value, state, pipeline stage and target date. Use centralstationcrm_deals_search to find a deal by name.
Inputs
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: people company tags.
orderstring- Sort order. Example: update-desc.one of
date-ascdate-descnew-ascnew-descupdate-ascupdate-descabc-ascabc-descvalue-ascvalue-descstate-ascstate-desc pageinteger- Page number, starting at 1. Example: 1.
perpageinteger- Records per page, up to 250. Example: 50.
tag_idinteger- Only deals with this tag ID. Example: 5678.
tag_namestring- Only deals with this tag name. Example: Q3.
centralstationcrm_deals_searchSearch deals by name.Read-onlySearch Deals
Search deals by name. Returns matching deals with ID, name, value and state. Use it to find a deal ID.
Inputs
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: company.
namestring- Deal name to match. Example: Website relaunch.
pageinteger- Page number, starting at 1. Example: 1.
perpageinteger- Records per page, up to 250. Example: 50.
centralstationcrm_group_calendars_listList the group calendars in the account.Read-onlyList Group Calendars
List the group calendars in the account. Returns each calendar's ID and name. Use the ID as group_calendar_id in centralstationcrm_calendar_event_create.
Inputs
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: tags.
orderstring- Ordering of records using one of the following order options: `id-asc`, `id-desc`. Example: example.
pageinteger- Page number, starting at 1. Example: 1.
perpageinteger- Records per page, up to 250. Example: 50.
centralstationcrm_note_getGet one note (protocol) by ID.Read-onlyGet Note
Get one note (protocol) by ID. Returns the note's type, title, content, date and linked records.
Inputs
note_idstringrequired- ID of the note. Get it from centralstationcrm_notes_list. Example: 1234567.
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: tags.
centralstationcrm_notes_listList notes (protocols) such as call notes and meeting notes, optionally for one person, company, deal or project.Read-onlyList Notes
List notes (protocols) such as call notes and meeting notes, optionally for one person, company, deal or project. Returns each note's ID, type, title, content and date. Use centralstationcrm_note_get for one note.
Inputs
company_idinteger- Only notes linked to this company. Example: 234567.
deal_idinteger- Only notes linked to this deal. Example: 345678.
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: people companies.
orderstring- Sort order. Example: date-desc.
pageinteger- Page number, starting at 1. Example: 1.
perpageinteger- Records per page, up to 250. Example: 50.
person_idinteger- Only notes linked to this person. Example: 1234567.
project_idinteger- Only notes linked to this project. Example: 456789.
centralstationcrm_people_countCount the people in the account.Read-onlyCount People
Count the people in the account. Returns the total number of people.
Inputs
tag_idinteger- Optionally submit a tag ID in order to only see people tagged with the submitted tag. Example: 1.
tag_namestring- Optionally submit a tag name in order to only see people tagged with the submitted tag. Example: example.
centralstationcrm_people_listList people (contacts), with paging, ordering and an optional tag filter.Read-onlyList People
List people (contacts), with paging, ordering and an optional tag filter. Returns each person's ID, name, title, background and owner, plus any includes. Use centralstationcrm_people_search to find people by name, email or phone.
Inputs
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: positions companies tags.
orderstring- Sort order. Example: update-desc.one of
date-ascdate-descnew-ascnew-descupdate-ascupdate-descabc-ascabc-desc pageinteger- Page number, starting at 1. Example: 1.
perpageinteger- Records per page, up to 250. Example: 50.
tag_idinteger- Only people with this tag ID. Example: 5678.
tag_namestring- Only people with this tag name. Example: VIP.
centralstationcrm_people_searchSearch people by name, first name, email or phone.Read-onlySearch People
Search people by name, first name, email or phone. Returns matching people with ID, name and any includes. Use it to find a person ID. Use centralstationcrm_search to search every record type.
Inputs
emailstring- Email address to match. Example: anna.miller@example.com.
first_namestring- First name to match. Example: Anna.
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: positions companies.
namestring- Last name to match. Example: Miller.
pageinteger- Page number, starting at 1. Example: 1.
perpageinteger- Records per page, up to 250. Example: 50.
phonestring- Phone number to match. Example: +49 30 1234567.
centralstationcrm_person_contact_details_listList a person's contact details: phone numbers, emails, websites and messenger handles.Read-onlyList Person Contact Details
List a person's contact details: phone numbers, emails, websites and messenger handles. Returns each detail's ID, type and value.
Inputs
person_idintegerrequired- ID of the person. Get it from centralstationcrm_people_search. Example: 1234567.
orderstring- Ordering of records using one of the following order options: `id-asc`, `id-desc`. Example: example.
pageinteger- Page number, starting at 1. Example: 1.
perpageinteger- Records per page, up to 250. Example: 50.
centralstationcrm_person_getGet one person by ID.Read-onlyGet Person
Get one person by ID. Returns the person's name, title, gender, background, owner and any includes such as emails, phone numbers and positions. Use centralstationcrm_people_search to find the ID.
Inputs
person_idintegerrequired- ID of the person. Get it from centralstationcrm_people_search. Example: 1234567.
includesstring- Related data to embed, separated by spaces, such as emails tels positions companies tags. Example: emails tels positions companies tags.
centralstationcrm_person_positions_listList a person's positions (job roles at companies).Read-onlyList Person Positions
List a person's positions (job roles at companies). Returns each position's company, job title and department.
Inputs
person_idintegerrequired- ID of the person. Get it from centralstationcrm_people_search. Example: 1234567.
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: tags.
orderstring- Ordering of records using one of the following order options: `id-asc`, `id-desc`. Example: example.
pageinteger- Page number, starting at 1. Example: 1.
perpageinteger- Records per page, up to 250. Example: 50.
centralstationcrm_project_getGet one project by ID.Read-onlyGet Project
Get one project by ID. Returns the project's name, state, target date, owner, background and any includes.
Inputs
project_idintegerrequired- ID of the project. Get it from centralstationcrm_projects_search. Example: 1234567.
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: people company tasks.
centralstationcrm_projects_listList projects, with paging, ordering and an optional tag filter.Read-onlyList Projects
List projects, with paging, ordering and an optional tag filter. Returns each project's ID, name, state, target date and owner. Use centralstationcrm_projects_search to find a project by name.
Inputs
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: people company tags.
orderstring- Sort order. Example: update-desc.one of
date-ascdate-descnew-ascnew-descupdate-ascupdate-descabc-ascabc-desc pageinteger- Page number, starting at 1. Example: 1.
perpageinteger- Records per page, up to 250. Example: 50.
tag_idinteger- Only projects with this tag ID. Example: 5678.
tag_namestring- Only projects with this tag name. Example: Onboarding.
centralstationcrm_projects_searchSearch projects by name.Read-onlySearch Projects
Search projects by name. Returns matching projects with ID, name and state. Use it to find a project ID.
Inputs
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: company.
namestring- Project name to match. Example: Onboarding.
pageinteger- Page number, starting at 1. Example: 1.
perpageinteger- Records per page, up to 250. Example: 50.
centralstationcrm_searchSearch people, companies, deals and projects at once by a term.Read-onlySearch All Records
Search people, companies, deals and projects at once by a term. Returns matching records grouped by type. Use it when the record type is unknown. Use the type-specific search tools to filter by type.
Inputs
termstringrequired- Text to search for, such as a name or email. Example: Miller.
centralstationcrm_task_getGet one task by ID.Read-onlyGet Task
Get one task by ID. Returns the task's name, due time, finished flag, owner and linked record.
Inputs
task_idstringrequired- ID of the task. Get it from centralstationcrm_tasks_list. Example: 1234567.
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: tags.
centralstationcrm_tasks_listList tasks, with paging, a state filter and a due-date window.Read-onlyList Tasks
List tasks, with paging, a state filter and a due-date window. Returns each task's ID, name, due time, finished flag, owner and linked record. Use centralstationcrm_task_get for one task.
Inputs
afterstring- Only tasks due after this date, YYYY-MM-DD. Example: 2026-01-01.
beforestring- Only tasks due before this date, YYYY-MM-DD. Example: 2026-12-31.
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: attachable.
orderstring- Sort order. Example: date-asc.
pageinteger- Page number, starting at 1. Example: 1.
perpageinteger- Records per page, up to 250. Example: 50.
statestring- Task state filter, such as open or finished. Example: open.
user_idstring- Only tasks of this user. Example: 12345.
centralstationcrm_users_listList the users of the CentralStationCRM account.Read-onlyList Users
List the users of the CentralStationCRM account. Returns each user's ID, name, email and active flag. Use it to find a user_id to assign records or tasks to.
Inputs
activestring- Set to true for active users only. Example: true.
pageinteger- Page number, starting at 1. Example: 1.
perpageinteger- Records per page, up to 250. Example: 50.
centralstationcrm_calendar_event_createCreate a calendar event for a user in a group calendar, optionally linked to a record.WriteCreate Calendar Event
Create a calendar event for a user in a group calendar, optionally linked to a record. Returns the new event with its ID. Use centralstationcrm_group_calendars_list for group_calendar_id.
Inputs
ends_atstringrequired- End, ISO 8601. Example: 2026-06-02T11:00:00+02:00.
group_calendar_idstringrequired- ID of the group calendar. Get it from centralstationcrm_group_calendars_list. Example: 3.
namestringrequired- Name. Example: Demo with Acme.
starts_atstringrequired- Start, ISO 8601. Example: 2026-06-02T10:00:00+02:00.
statusstringrequired- Event status, such as confirmed or tentative. Example: confirmed.
user_idintegerrequired- ID of the user the event belongs to. Example: 12345.
all_dayboolean- true for an all-day event. Example: false.
attachable_idinteger- ID of the linked record. Example: 234567.
attachable_typestring- Type of the linked record: Person, Company, Deal or Project. Example: Company.one of
PersonCompanyDealProject descriptionstring- details regarding the event, e.g. agenda. Example: Product demo.
email_invitationsboolean- true to email invitations to attendees. Example: false.
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: tags.
locationstring- description of the location, can be an address, a Meeting room id or left blank. Example: Online.
centralstationcrm_calendar_event_updateUpdate a calendar event's name, time, location or status.WriteUpdate Calendar Event
Update a calendar event's name, time, location or status. Returns the updated event. Only the fields you pass change.
- Idempotent
Inputs
calendar_event_idstringrequired- ID of the calendar event. Get it from centralstationcrm_calendar_events_list. Example: 1234567.
all_dayboolean- set to true for events that last the whole day (e.g. holidays). Example: false.
attachable_idinteger- id of the record the cal event belongs to (e.g. a person). Example: 234567.
attachable_typestring- Type of the linked record: Person, Company, Deal or Project. Example: Company.one of
PersonCompanyDealProject descriptionstring- details regarding the event, e.g. agenda. Example: Product demo.
email_invitationsboolean- set to true and CSCRM will send out email invitations to all attendees. Example: false.
ends_atstring- End, ISO 8601. Example: 2026-06-02T11:00:00+02:00.
group_calendar_idstring- Group Calendar ID. Example: 3.
locationstring- description of the location, can be an address, a Meeting room id or left blank. Example: Online.
namestring- Name. Example: Demo with Acme.
starts_atstring- Start, ISO 8601. Example: 2026-06-02T10:00:00+02:00.
statusstring- can be new, confirmed, tentative or cancelled. Example: confirmed.
user_idinteger- User ID. Example: 12345.
centralstationcrm_comment_createAdd a comment to a record such as a note, task or calendar event.WriteCreate Comment
Add a comment to a record such as a note, task or calendar event. Returns the new comment.
Inputs
namestringrequired- Comment text. Example: Thanks, I'll follow up.
attachable_idstring- ID of the record to comment on. Example: 998877.
attachable_typestring- Type of the record to comment on. Example: Protocol.one of
AttachmentCalEventProtocolExternalEmailTask
centralstationcrm_company_contact_detail_createAdd a phone number, email or other contact detail to a company.WriteAdd Company Contact Detail
Add a phone number, email or other contact detail to a company. Returns the new contact detail. Set attachable_type to Company and attachable_id to the same ID as company_id.
Inputs
attachable_idintegerrequired- ID of the company; the same value as company_id. Example: 234567.
attachable_typestringrequired- Record type the detail belongs to: Company. Example: Company.one of
Company atypestringrequired- Kind of detail: office, office_hq, mobile, fax, private, voip, skype or other. Example: office.one of
officeoffice_hqmobilefaxprivatevoipskypeother company_idintegerrequired- ID of the company. Get it from centralstationcrm_companies_search. Example: 234567.
namestringrequired- The phone number or address itself. Example: +49 30 1234567.
centralstationcrm_company_createCreate a company.WriteCreate Company
Create a company. Returns the new company with its ID. Link people to it with centralstationcrm_person_position_create.
Inputs
namestringrequired- Company name. Example: Acme GmbH.
backgroundstring- Background notes about the company. Example: Wholesale partner since 2024.
group_idinteger- ID of the group. Example: 10.
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: tags.
user_idinteger- ID of the responsible user. Get it from centralstationcrm_users_list. Example: 12345.
centralstationcrm_company_updateUpdate a company's name, background or owner.WriteUpdate Company
Update a company's name, background or owner. Returns the updated company. Only the fields you pass change.
- Idempotent
Inputs
company_idstringrequired- ID of the company. Get it from centralstationcrm_companies_search. Example: 1234567.
backgroundstring- Background notes. Example: Wholesale partner since 2024.
group_idinteger- ID of the group. Example: 10.
namestring- Company name. Example: Acme GmbH.
user_idinteger- ID of the responsible user. Example: 12345.
centralstationcrm_deal_createCreate a deal in a pipeline.WriteCreate Deal
Create a deal in a pipeline. Returns the new deal with its ID. Use centralstationcrm_deal_types_list to find the pipeline (deal_type_id) and stage IDs.
Inputs
namestringrequired- Name. Example: Website relaunch.
backgroundstring- details about the deal e.g. history. Example: Inbound lead from webinar.
company_idinteger- ID of the company. Get it from centralstationcrm_companies_search. Example: 234567.
currencystring- currency of the deal, either EUR, CHF or USD. Default is EUR. Example: EUR.
deal_type_idinteger- ID of the pipeline. Get it from centralstationcrm_deal_types_list. Example: 1.
deal_type_stage_idinteger- ID of the stage in the pipeline. Get it from centralstationcrm_deal_type_get. Example: 2.
group_idinteger- Group ID. Example: 10.
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: tags.
probabilityinteger- Chance of winning in percent, 0 to 100. Example: 25.
target_datestring- The date when the deal shall be won. Example: 2026-12-31.
user_idinteger- ID of the responsible user. Get it from centralstationcrm_users_list. Example: 12345.
valuestring- The monetary value of the deal; can be null depending on the pipeline configuration. Example: 15000.
value_countstring- Only relevant if the value_type is other than total. Example: 1.
value_typestring- The type of billing, either `total`, `monthly`, `hourly` or `daily`. Can be null depending on the pipeline configuration. Example: total.
centralstationcrm_deal_updateUpdate a deal's name, value, stage, probability, target date or owner.WriteUpdate Deal
Update a deal's name, value, stage, probability, target date or owner. Returns the updated deal. Only the fields you pass change.
- Idempotent
Inputs
deal_idstringrequired- ID of the deal. Get it from centralstationcrm_deals_search. Example: 1234567.
backgroundstring- details about the deal e.g. history. Example: Inbound lead from webinar.
company_idinteger- Company ID. Example: 234567.
currencystring- currency of the deal, either EUR, CHF or USD. Default is EUR. Example: EUR.
current_statestring- Set to won or lost to close the deal; open0, open25, open50 or open75 for an open deal without pipeline stages. Example: won.one of
open0open25open50open75wonlost deal_type_idinteger- ID of the pipeline. Example: 1.
deal_type_stage_idinteger- ID of the stage in the pipeline. Example: 2.
group_idinteger- Group ID. Example: 10.
namestring- Name. Example: Website relaunch.
probabilityinteger- Chance of winning in percent, 0 to 100. Example: 25.
target_datestring- The date when the deal shall be won. Example: 2026-12-31.
user_idinteger- User ID. Example: 12345.
valuestring- The monetary value of the deal; can be null depending on the pipeline configuration. Example: 15000.
value_countstring- Only relevant if the value_type is other than total. Example: 1.
value_typestring- The type of billing, either `total`, `monthly`, `hourly` or `daily`. Can be null depending on the pipeline configuration. Example: total.
centralstationcrm_note_createCreate a note (protocol), such as a call or meeting note, linked to people, companies, deals or projects.WriteCreate Note
Create a note (protocol), such as a call or meeting note, linked to people, companies, deals or projects. Returns the new note with its ID.
Inputs
contentstringrequired- Text of the note. Example: Discussed the offer; follow up next week.
badgestring- DEPRECATED: Use conversion_step_names instead. Protocols created in the web interface always have the badge note, the type chosen there (e.g. call or meeting) is stored as a conversion step. Read it via the methods parameter (`methods=conversion_step_names`) and set it via `conversion_step_names` in the protocol object. For a ProtocolEmail the badge can only be email, for a ProtocolObjectNote it can be one of note, call, email, meeting or other. Example: call.
company_idsarray- An array of the company ids the protocol shall be assigned to. Example: [234567].
confidentialboolean- true to hide the note from other users. Example: false.
conversion_step_namesarray- An array of conversion step names the protocol shall be assigned to. Leading and trailing whitespace is removed, then each name has to match an existing conversion step exactly. This is the type chosen in the web interface (e.g. call or meeting). Example: ["meeting"].
deal_idsarray- An array of the deal ids the protocol shall be assigned to. Example: [345678].
formatstring- Content format. Example: markdown.
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: tags.
namestring- Title of the note. Example: Call with Anna.
occurred_atstring- When it happened, ISO 8601. Example: 2026-05-20T14:00:00+02:00.
person_idsarray- An array of the person ids the protocol shall be assigned to. Example: [1234567].
project_idsarray- An array of the project ids the protocol shall be assigned to. Example: [456789].
typestring- Note type, such as call, meeting or note. Example: call.
centralstationcrm_note_updateUpdate a note's title, content, date or links.WriteUpdate Note
Update a note's title, content, date or links. Returns the updated note. Only the fields you pass change.
- Idempotent
Inputs
note_idstringrequired- ID of the note. Get it from centralstationcrm_notes_list. Example: 1234567.
badgestring- DEPRECATED: Use conversion_step_names instead. Protocols created in the web interface always have the badge note, the type chosen there (e.g. call or meeting) is stored as a conversion step. Read it via the methods parameter (`methods=conversion_step_names`) and set it via `conversion_step_names` in the protocol object. For a ProtocolEmail the badge can only be email, for a ProtocolObjectNote it can be one of note, call, email, meeting or other. Example: call.
company_idsarray- An array of the company ids the protocol shall be assigned to. Example: [234567].
confidentialboolean- set to true and this protocol will only be visible for users that have at least poweruser rights. Example: false.
contentstring- Text of the note. Example: Discussed the offer; follow up next week.
conversion_step_namesarray- An array of conversion step names the protocol shall be assigned to. Leading and trailing whitespace is removed, then each name has to match an existing conversion step exactly. This is the type chosen in the web interface (e.g. call or meeting). Example: ["example"].
deal_idsarray- An array of the deal ids the protocol shall be assigned to. Example: [345678].
formatstring- Decides how the content will be interpreted. Can be either `plaintext` or `markdown`. Example: markdown.
namestring- Title of the note. Example: Call with Anna.
occurred_atstring- When the documented event took place (shown as the date of the protocol in the activity stream). Defaults to the time of creation. Set it e.g. when importing historic notes. In contrast, `created_at` is always the time the protocol was created in CentralStationCRM and cannot be changed. Example: 2026-05-20T14:00:00+02:00.
person_idsarray- An array of the person ids the protocol shall be assigned to. Example: [1234567].
project_idsarray- An array of the project ids the protocol shall be assigned to. Example: [456789].
typestring- type of the protocol can be one of ProtocolObjectNote, ProtocolExternal or ProtocolEmail. Example: call.
centralstationcrm_person_address_createAdd a postal address to a person.WriteAdd Person Address
Add a postal address to a person. Returns the new address. Set attachable_type to Person and attachable_id to the same ID as person_id.
Inputs
attachable_idintegerrequired- ID of the person; the same value as person_id. Example: 1234567.
attachable_typestringrequired- Record type the address belongs to: Person. Example: Person.one of
Person citystringrequired- The city name. Either the city or the country_code is mandatory. Example: Berlin.
person_idintegerrequired- ID of the person. Get it from centralstationcrm_people_search. Example: 1234567.
atypestring- Kind of address, such as work, private or delivery. Example: work.
country_codestring- Two-letter country code, such as DE. Example: DE.
primaryboolean- true to make it the primary address. Example: true.
state_codestring- State or region code. Example: BE.
streetstring- The street including the house number or other details (building, c/o). Example: Hauptstrasse 1.
zipstring- The zip code. Example: 10115.
centralstationcrm_person_contact_detail_createAdd a phone number, email or other contact detail to a person.WriteAdd Person Contact Detail
Add a phone number, email or other contact detail to a person. Returns the new contact detail. Set attachable_type to Person and attachable_id to the same ID as person_id.
Inputs
attachable_idintegerrequired- ID of the person; the same value as person_id. Example: 1234567.
attachable_typestringrequired- Record type the detail belongs to: Person. Example: Person.one of
Person atypestringrequired- Kind of detail: office, office_hq, mobile, fax, private, voip, skype or other. Example: mobile.one of
officeoffice_hqmobilefaxprivatevoipskypeother namestringrequired- The phone number or address itself. Example: +49 170 1234567.
person_idintegerrequired- ID of the person. Get it from centralstationcrm_people_search. Example: 1234567.
centralstationcrm_person_createCreate a person (contact).WriteCreate Person
Create a person (contact). Returns the new person with its ID. Add emails, phones and addresses afterwards with centralstationcrm_person_contact_detail_create and centralstationcrm_person_address_create.
Inputs
namestringrequired- Last name of the person. Example: Miller.
backgroundstring- Background notes about the person. Example: Met at the 2026 trade fair.
country_codestring- Two-letter country code, such as DE. Example: DE.
first_namestring- First name. Example: Anna.
genderstring- Gender. Example: female.
group_idinteger- ID of the group the person belongs to. Example: 10.
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: tags.
salutationstring- Salutation, such as Mr or Ms. Example: Ms.
titlestring- Academic title, such as Dr. Example: Dr.
user_idinteger- ID of the user responsible for the person. Get it from centralstationcrm_users_list. Example: 12345.
centralstationcrm_person_position_createLink a person to a company with a job title and department.WriteAdd Person Position
Link a person to a company with a job title and department. Returns the new position. Use centralstationcrm_companies_search to find the company ID.
Inputs
company_idintegerrequired- ID of the company. Get it from centralstationcrm_companies_search. Example: 234567.
person_idintegerrequired- ID of the person. Get it from centralstationcrm_people_search. Example: 1234567.
company_namestring- Company name, if no company_id is given. Example: Acme GmbH.
departmentstring- Department. Example: Sales.
formerboolean- true if the person no longer holds this position. Example: false.
namestring- Job title. Example: Head of Sales.
primary_functionboolean- true if this is the person's main position. Example: true.
centralstationcrm_person_updateUpdate a person's name, title, background or owner.WriteUpdate Person
Update a person's name, title, background or owner. Returns the updated person. Only the fields you pass change.
- Idempotent
Inputs
person_idstringrequired- ID of the person. Get it from centralstationcrm_people_search. Example: 1234567.
backgroundstring- Background notes about the person. Example: Met at the 2026 trade fair.
country_codestring- Two-letter country code, such as DE. Example: DE.
first_namestring- First name. Example: Anna.
genderstring- Gender. Example: female.
group_idinteger- ID of the group the person belongs to. Example: 10.
namestring- Last name of the person. Example: Miller.
salutationstring- Salutation, such as Mr or Ms. Example: Ms.
titlestring- Academic title, such as Dr. Example: Dr.
user_idinteger- ID of the user responsible for the person. Get it from centralstationcrm_users_list. Example: 12345.
centralstationcrm_project_createCreate a project.WriteCreate Project
Create a project. Returns the new project with its ID.
Inputs
namestringrequired- Name. Example: Acme onboarding.
target_datestringrequired- Planned end date, YYYY-MM-DD. Example: 2026-12-31.
backgroundstring- details about the project e.g. history. Example: Kick-off in January.
company_idinteger- ID of the company. Example: 234567.
current_statestring- Project state, such as open or finished. Example: open.
deal_idinteger- ID of the related deal. Example: 345678.
finished_atstring- Date the project was finished, YYYY-MM-DD. Example: 2026-12-20.
group_idinteger- Group ID. Example: 10.
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: tags.
person_ids_setstring- assign people to the project by sending comma separated ids (e.g. `42,4711`). Example: example.
user_idinteger- ID of the responsible user. Example: 12345.
centralstationcrm_project_updateUpdate a project's name, state, target date or owner.WriteUpdate Project
Update a project's name, state, target date or owner. Returns the updated project. Only the fields you pass change.
- Idempotent
Inputs
project_idstringrequired- ID of the project. Get it from centralstationcrm_projects_search. Example: 1234567.
backgroundstring- details about the project e.g. history. Example: Kick-off in January.
company_idinteger- Company ID. Example: 234567.
current_statestring- Project state, such as open or finished. Example: finished.
deal_idinteger- Deal ID. Example: 345678.
finished_atstring- Date the project was finished, YYYY-MM-DD. Example: 2026-12-20.
group_idinteger- Group ID. Example: 10.
namestring- Name. Example: Acme onboarding.
person_ids_setstring- assign people to the project by sending comma separated ids (e.g. `42,4711`). Example: example.
target_datestring- Planned end date, YYYY-MM-DD. Example: 2026-12-31.
user_idinteger- User ID. Example: 12345.
centralstationcrm_tag_createTag a person, company, deal or project.WriteAdd Tag
Tag a person, company, deal or project. Returns the new tag. Use centralstationcrm_tags_list to see existing tag names.
Inputs
attachable_idintegerrequired- ID of the record to tag. Example: 1234567.
attachable_typestringrequired- Type of the record to tag: Person, Company, Deal or Project. Example: Person.one of
PersonCompanyDealProject namestringrequired- Tag name. Example: VIP.
centralstationcrm_task_createCreate a task for a user, optionally linked to a person, company, deal or project.WriteCreate Task
Create a task for a user, optionally linked to a person, company, deal or project. Returns the new task with its ID.
Inputs
namestringrequired- Task text. Example: Call Anna about the offer.
user_idintegerrequired- ID of the user the task is assigned to. Get it from centralstationcrm_users_list. Example: 12345.
attachable_idinteger- ID of the linked record. Example: 1234567.
attachable_typestring- Type of the linked record: Person, Company, Deal or Project. Example: Person.one of
PersonCompanyDealProject badgestring- Task badge, such as call, email or meeting. Example: call.
finishedboolean- true if the task is already done. Example: false.
fuzzyboolean- true if the due date has no exact time. Example: false.
includesstring- Related data to embed, separated by spaces. Request only what you need; avoid all. Example: tags.
precise_timestring- Due date and time, ISO 8601. Example: 2026-06-01T10:00:00+02:00.
task_list_idinteger- ID of a task list to add the task to. Example: 77.
centralstationcrm_task_updateUpdate a task's text, due time or owner, or mark it finished.WriteUpdate Task
Update a task's text, due time or owner, or mark it finished. Returns the updated task. Only the fields you pass change.
- Idempotent
Inputs
task_idstringrequired- ID of the task. Get it from centralstationcrm_tasks_list. Example: 1234567.
attachable_idinteger- id of the record the task belongs to (e.g. a person). Example: 1234567.
attachable_typestring- Type of the linked record: Person, Company, Deal or Project. Example: Person.one of
PersonCompanyDealProject badgestring- can be task, call, email, visit, preparation or important. Default will be task. Example: call.
finishedboolean- true to mark the task done. Example: true.
fuzzyboolean- set to true, if the precise_time hour and minutes are irrelevant, but the task may be done at any time during the day. Example: false.
namestring- Name. Example: Call Anna about the offer.
precise_timestring- Due date and time, ISO 8601. Example: 2026-06-01T10:00:00+02:00.
task_list_idinteger- id of the task list the task belongs to (has to be within the attachable record). Example: 77.
user_idinteger- User ID. Example: 12345.
centralstationcrm_calendar_event_deleteDelete a calendar event.DestructiveDelete Calendar Event
Delete a calendar event. Returns an empty response on success.
- Idempotent
Inputs
calendar_event_idstringrequired- ID of the calendar event. Get it from centralstationcrm_calendar_events_list. Example: 1234567.
centralstationcrm_company_deleteDelete a company and the data attached to it.DestructiveDelete Company
Delete a company and the data attached to it. Returns an empty response on success.
- Idempotent
Inputs
company_idstringrequired- ID of the company. Get it from centralstationcrm_companies_search. Example: 1234567.
centralstationcrm_deal_deleteDelete a deal.DestructiveDelete Deal
Delete a deal. Returns an empty response on success.
- Idempotent
Inputs
deal_idstringrequired- ID of the deal. Get it from centralstationcrm_deals_search. Example: 1234567.
centralstationcrm_note_deleteDelete a note (protocol).DestructiveDelete Note
Delete a note (protocol). Returns an empty response on success.
- Idempotent
Inputs
note_idstringrequired- ID of the note. Get it from centralstationcrm_notes_list. Example: 1234567.
centralstationcrm_person_deleteDelete a person and the data attached to them.DestructiveDelete Person
Delete a person and the data attached to them. Returns an empty response on success.
- Idempotent
Inputs
person_idstringrequired- ID of the person. Get it from centralstationcrm_people_search. Example: 1234567.
centralstationcrm_project_deleteDelete a project.DestructiveDelete Project
Delete a project. Returns an empty response on success.
- Idempotent
Inputs
project_idstringrequired- ID of the project. Get it from centralstationcrm_projects_search. Example: 1234567.
centralstationcrm_task_deleteDelete a task.DestructiveDelete Task
Delete a task. Returns an empty response on success.
- Idempotent
Inputs
task_idstringrequired- ID of the task. Get it from centralstationcrm_tasks_list. Example: 1234567.
No tools match.