centralstationcrm_get_current_user
Get current user
The CentralStationCRM user this API key belongs to: id, name, login email, the account (subdomain) it is signed in to, timezone. Use the user id to assign records or tasks. GET /user.
Takes no parameters.
centralstationcrm_list_users
List users
List the users of the CentralStationCRM account (id, name, email). Use the ids for responsible-user filters and for assigning records. GET /users.
Parameterspageactiveperpage
centralstationcrm_list_people
List people
List contact people. Optionally filter by tag and order by name, creation or last update. Use search_people to find a person by name, email or phone. GET /people.
Parameterspageorderperpageincludestag_name
centralstationcrm_search_people
Search people
Find people by last name, first name, email address or phone number (email and phone cannot be combined). Give at least one criterion. GET /people/search.
Parametersnamepageemailphoneperpageincludesfirst_name
centralstationcrm_get_person
Get person
One person by id, optionally with related records (companies, deals, tags, tasks, email addresses, phone numbers, addresses). GET /people/{id}.
Parametersincludesperson_idrequired
centralstationcrm_list_companies
List companies
List companies. Optionally filter by tag and order by name, creation or last update. Use search_companies to find one by name. GET /companies.
Parameterspageorderperpageincludestag_name
centralstationcrm_search_companies
Search companies
Find companies by name. GET /companies/search.
Parametersnamerequiredpageperpageincludes
centralstationcrm_get_company
Get company
One company by id, optionally with related records (people, deals, tags, tasks, contact details, addresses). GET /companies/{id}.
Parametersincludescompany_idrequired
centralstationcrm_list_deals
List deals
List deals (sales opportunities) with value, state (open_0/25/50/75, won, lost), pipeline and stage ids, target date. Filter by company, responsible user, pipeline or state; order by date, value, state or name. GET /deals.
Parameterspageorderperpageuser_idincludestag_namecompany_iddeal_type_idcurrent_state
centralstationcrm_search_deals
Search deals
Find deals by name. GET /deals/search.
Parametersnamerequiredpageperpageincludes
centralstationcrm_get_deal
Get deal
One deal by id, optionally with its tags, people, company, tasks and calendar events. GET /deals/{id}.
Parametersdeal_idrequiredincludes
centralstationcrm_get_deal_stats
Get deal statistics
Number and total value of all deals (optionally only those with a tag), with the account currency. GET /deals/stats.
Parameterstag_name
centralstationcrm_list_deal_types
List deal pipelines
List the deal types (pipelines) with their stages. Use the ids (and stage ids) to create deals and to move them between stages. GET /deal_types.
Takes no parameters.
centralstationcrm_list_projects
List projects
List projects with state, target date and company. Filter by tag; order by date, state or name. GET /projects.
Parameterspageorderperpageincludestag_name
centralstationcrm_search_projects
Search projects
Find projects by name. GET /projects/search.
Parametersnamerequiredpageperpageincludes
centralstationcrm_get_project
Get project
One project by id, optionally with its tags, people, company, tasks and calendar events. GET /projects/{id}.
Parametersincludesproject_idrequired
centralstationcrm_list_tasks
List tasks
List tasks (to-dos, calls, emails, visits) of the account. Filter by open/closed state, due-date range and responsible user. GET /tasks.
Parameterspageafterorderstatebeforeperpageuser_id
centralstationcrm_get_task
Get task
One task by id. GET /tasks/{id}.
Parameterstask_idrequired
centralstationcrm_list_notes
List notes and activity log entries
List protocols: notes, logged emails and other history entries. Filter by the person, company, deal or project they belong to. GET /protocols.
Parameterspageorderdeal_idperpageperson_idcompany_idproject_id
centralstationcrm_get_note
Get note
One note / history entry by id. GET /protocols/{id}.
Parametersnote_idrequired
centralstationcrm_list_calendar_events
List calendar events
List calendar events (appointments, meetings) of the account. Filter by upcoming/old and date range. GET /cal_events.
Parameterspageafterorderstatebeforeperpage
centralstationcrm_search_all
Search everything
Full-text search across people, companies, deals and projects for a term. GET /search.
Parameterstermrequired
centralstationcrm_list_tags
List tags
List all tag names used in the account. GET /tags/list.
Parameterspageperpage
centralstationcrm_count_records
Count records
Total number of people, companies, deals or projects (optionally only those with a tag). GET /<resource>/count.
Parametersresourcerequiredtag_name
centralstationcrm_create_person
Create person
WRITE: create a contact person (last name required), optionally with email addresses and phone numbers. Nothing is sent to the contact. POST /people.
Parametersnamerequiredtitleemailsphonesuser_idbackgroundfirst_namesalutationcountry_code
centralstationcrm_update_person
Update person
WRITE: change fields of a person. Only the fields you give are sent; the rest stays. PUT /people/{id}.
Parametersnametitleuser_idperson_idrequiredbackgroundfirst_namesalutationcountry_code
centralstationcrm_create_company
Create company
WRITE: create a company. Nothing is sent to the contact. POST /companies.
Parametersnamerequireduser_idbackground
centralstationcrm_update_company
Update company
WRITE: change fields of a company. Only the fields you give are sent. PUT /companies/{id}.
Parametersnameuser_idbackgroundcompany_idrequired
centralstationcrm_create_deal
Create deal
WRITE: create a deal (sales opportunity). Use list_deal_types for pipeline and stage ids. Pipelines with a monetary value or target date need value and target_date (value_type defaults to total); the vendor says what is missing. Nothing is sent to the contact. POST /deals.
Parametersnamerequiredvalueuser_idcurrencybackgroundcompany_idvalue_typeprobabilitytarget_datedeal_type_iddeal_type_stage_id
centralstationcrm_update_deal
Update deal
WRITE: change fields of a deal, for example move it to another stage or set its state to won or lost. Only the fields you give are sent. PUT /deals/{id}.
Parametersnamevaluedeal_idrequireduser_idcurrencybackgroundcompany_idvalue_typeprobabilitytarget_datedeal_type_idcurrent_state+1 more
centralstationcrm_create_task
Create task
WRITE: create a task (to-do, call, email, visit...) optionally attached to a person, company or deal and assigned to a user. Nothing is sent to the contact. POST /tasks.
Parametersnamerequiredbadgefuzzyuser_idprecise_timeattachable_idattachable_type
centralstationcrm_update_task
Update task
WRITE: change a task, for example mark it done (finished = true), rename it or reschedule it. Only the fields you give are sent. PUT /tasks/{id}.
Parametersnamebadgefuzzytask_idrequireduser_idfinishedprecise_time
centralstationcrm_create_note
Create note
WRITE: add a note to the history of one or more people, companies, deals or projects. Nothing is sent to the contact. POST /protocols.
Parametersnamerequiredcontentrequireddeal_idsperson_idscompany_idsproject_idsconfidential