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

Tools

ToolDescription
centralstationcrm_people_delete_api_people_by_idDestroy a person
centralstationcrm_people_delete_api_people_by_person_id_addrs_by_idDestroy a addrs
centralstationcrm_people_delete_api_people_by_person_id_assis_by_idDestroy a assi
centralstationcrm_people_delete_api_people_by_person_id_avatars_by_iddelete avatar
centralstationcrm_people_delete_api_people_by_person_id_contact_details_by_idDestroy a contact_detail
centralstationcrm_people_delete_api_people_by_person_id_custom_fields_by_idDestroy a custom_field
centralstationcrm_people_delete_api_people_by_person_id_historic_events_by_idDestroy a historic_event
centralstationcrm_people_delete_api_people_by_person_id_positions_by_idDestroy a position
centralstationcrm_people_delete_api_people_by_person_id_tags_by_idDestroy a tag
centralstationcrm_people_get_api_peopleRetrieves all people
centralstationcrm_people_get_api_people_by_idRetrieves a person
centralstationcrm_people_get_api_people_by_person_id_addrsRetrieves all addrs of the person
centralstationcrm_people_get_api_people_by_person_id_addrs_by_idRetrieves the addr
centralstationcrm_people_get_api_people_by_person_id_assisRetrieves all assis of the person
centralstationcrm_people_get_api_people_by_person_id_assis_by_idRetrieves the assi
centralstationcrm_people_get_api_people_by_person_id_avatarsRetrieves all avatars
centralstationcrm_people_get_api_people_by_person_id_avatars_by_idretrieve avatar
centralstationcrm_people_get_api_people_by_person_id_contact_detailsRetrieves all contact_details of the person
centralstationcrm_people_get_api_people_by_person_id_contact_details_by_idRetrieves the tel
centralstationcrm_people_get_api_people_by_person_id_custom_fieldsRetrieves all custom_fields of the person
centralstationcrm_people_get_api_people_by_person_id_custom_fields_by_idRetrieves the custom field
centralstationcrm_people_get_api_people_by_person_id_external_emailsRetrieves all external_emails
centralstationcrm_people_get_api_people_by_person_id_external_emails_countRetrieves total amount of external_emails
centralstationcrm_people_get_api_people_by_person_id_historic_eventsRetrieves all historic_events of the person
centralstationcrm_people_get_api_people_by_person_id_historic_events_by_idRetrieves the historic_event
centralstationcrm_people_get_api_people_by_person_id_positionsRetrieves all positions
centralstationcrm_people_get_api_people_by_person_id_positions_by_idRetrieves a position
centralstationcrm_people_get_api_people_by_person_id_tagsRetrieves all tags
centralstationcrm_people_get_api_people_by_person_id_tags_by_idRetrieves a tag
centralstationcrm_people_get_api_people_countRetrieves total amount of people
centralstationcrm_people_get_api_people_searchRetrieves people matching the search
centralstationcrm_people_get_api_people_statsRetrieves key information of people
centralstationcrm_people_post_api_peoplecreates a person
centralstationcrm_people_post_api_people_by_id_mergemerge another person
centralstationcrm_people_post_api_people_by_person_id_addrsCreates a basic Addr
centralstationcrm_people_post_api_people_by_person_id_assisCreates an assi of the person
centralstationcrm_people_post_api_people_by_person_id_avatarscreate avatar
centralstationcrm_people_post_api_people_by_person_id_contact_detailsCreates a basic tel
centralstationcrm_people_post_api_people_by_person_id_custom_fieldsCreates a basic custom field
centralstationcrm_people_post_api_people_by_person_id_historic_eventsCreates a basic historic_event
centralstationcrm_people_post_api_people_by_person_id_positionsCreates a basic position
centralstationcrm_people_post_api_people_by_person_id_tagsCreates a basic tag
centralstationcrm_people_put_api_people_by_idUpdate a person
centralstationcrm_people_put_api_people_by_person_id_addrs_by_idUpdate a addr
centralstationcrm_people_put_api_people_by_person_id_assis_by_idUpdate a assi
centralstationcrm_people_put_api_people_by_person_id_contact_details_by_idUpdate a contact_detail
centralstationcrm_people_put_api_people_by_person_id_custom_fields_by_idUpdate a custom_field
centralstationcrm_people_put_api_people_by_person_id_historic_events_by_idUpdate a historic_event
centralstationcrm_people_put_api_people_by_person_id_positions_by_idUpdate a position
centralstationcrm_people_put_api_people_by_person_id_tags_by_idUpdate a tag

centralstationcrm_people_delete_api_people_by_id

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

centralstationcrm_people_delete_api_people_by_person_id_addrs_by_id

Destroy a addrs Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the addr belong to
idintegerYesID of the contact detail

centralstationcrm_people_delete_api_people_by_person_id_assis_by_id

Destroy a assi Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the assi belong to
idintegerYesID of the assi

centralstationcrm_people_delete_api_people_by_person_id_avatars_by_id

delete avatar Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
person_idstringYesperson_id

centralstationcrm_people_delete_api_people_by_person_id_contact_details_by_id

Destroy a contact_detail Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the contact details belong to
idintegerYesID of the contact detail

centralstationcrm_people_delete_api_people_by_person_id_custom_fields_by_id

Destroy a custom_field Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the custom fields belong to
idintegerYesID of the custom field

centralstationcrm_people_delete_api_people_by_person_id_historic_events_by_id

Destroy a historic_event Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the historic event belong to
idintegerYesID of the historic event

centralstationcrm_people_delete_api_people_by_person_id_positions_by_id

Destroy a position Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesperson_id
idstringYesid

centralstationcrm_people_delete_api_people_by_person_id_tags_by_id

Destroy a tag Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesperson_id
idstringYesid

centralstationcrm_people_get_api_people

Retrieves all people Parameters:
ParameterTypeRequiredDefaultDescription
perpageintegerNoElements per page, maximum of 250
pageintegerNoRetrieve records of the given page
orderstringNoOrdering of records using one of the following order options: abc-asc, abc-desc, new-asc, new-desc, update-asc, update-desc
includesstringNopossible 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.
methodsstringNoPossible 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.
tag_idintegerNoOptionally submit a tag ID in order to only see people tagged with the submitted tag
tag_namestringNoOptionally submit a tag name in order to only see people tagged with the submitted tag
stream_updated_at_beforestringNoOptionally 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.
stream_updated_at_afterstringNoOptionally 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.
custom_fieldsstringNoOptionally submit one or multiple custom field types to filter by their value. This shall be formatted like custom_fields[custom_field_type_id]=value
filterobjectNoOptionally 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' }).

centralstationcrm_people_get_api_people_by_id

Retrieves a person Parameters:
ParameterTypeRequiredDefaultDescription
idintegerYesid
includesstringNopossible 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.
methodsstringNoPossible 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.

centralstationcrm_people_get_api_people_by_person_id_addrs

Retrieves all addrs of the person Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the contact details belong to
perpageintegerNoElements per page, maximum of 250
pageintegerNoRetrieve records of the given page
orderstringNoOrdering of records using one of the following order options: id-asc, id-desc

centralstationcrm_people_get_api_people_by_person_id_addrs_by_id

Retrieves the addr Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the addr belong to
idintegerYesID of the addr

centralstationcrm_people_get_api_people_by_person_id_assis

Retrieves all assis of the person Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the assi belong to
orderstringNoOrdering of records using one of the following order options: id-asc, id-desc
perpageintegerNoElements per page, maximum of 250
pageintegerNoRetrieve records of the given page

centralstationcrm_people_get_api_people_by_person_id_assis_by_id

Retrieves the assi Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the assi belong to
idintegerYesID of the assi

centralstationcrm_people_get_api_people_by_person_id_avatars

Retrieves all avatars Parameters:
ParameterTypeRequiredDefaultDescription
perpageintegerNoElements per page, maximum of 250
pageintegerNoRetrieve records of the given page
person_idstringYesperson_id

centralstationcrm_people_get_api_people_by_person_id_avatars_by_id

retrieve avatar Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
person_idstringYesperson_id

centralstationcrm_people_get_api_people_by_person_id_contact_details

Retrieves all contact_details of the person Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the contact details belong to
orderstringNoOrdering of records using one of the following order options: id-asc, id-desc
perpageintegerNoElements per page, maximum of 250
pageintegerNoRetrieve records of the given page

centralstationcrm_people_get_api_people_by_person_id_contact_details_by_id

Retrieves the tel Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the contact details belong to
idintegerYesID of the contact detail

centralstationcrm_people_get_api_people_by_person_id_custom_fields

Retrieves all custom_fields of the person Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the custom fields belong to
orderstringNoOrdering of records using one of the following order options: id-asc, id-desc
perpageintegerNoElements per page, maximum of 250
pageintegerNoRetrieve records of the given page
includesstringNopossible option: custom_fields_type

centralstationcrm_people_get_api_people_by_person_id_custom_fields_by_id

Retrieves the custom field Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the custom fields belong to
idintegerYesID of the custom field
includesstringNopossible option: custom_fields_type

centralstationcrm_people_get_api_people_by_person_id_external_emails

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

centralstationcrm_people_get_api_people_by_person_id_external_emails_count

Retrieves total amount of external_emails Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the external_emails of the desired person

centralstationcrm_people_get_api_people_by_person_id_historic_events

Retrieves all historic_events of the person Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the historic event belong to
orderstringNoOrdering of records using one of the following order options: id-asc, id-desc
perpageintegerNoElements per page, maximum of 250
pageintegerNoRetrieve records of the given page

centralstationcrm_people_get_api_people_by_person_id_historic_events_by_id

Retrieves the historic_event Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the historic event belong to
idintegerYesID of the historic event

centralstationcrm_people_get_api_people_by_person_id_positions

Retrieves all positions Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesperson_id
orderstringNoOrdering of records using one of the following order options: id-asc, id-desc
perpageintegerNoElements per page, maximum of 250
pageintegerNoRetrieve records of the given page
includesstringNopossible includes are: person, company separated by space. Receive all includes using the ‘all’ value.

centralstationcrm_people_get_api_people_by_person_id_positions_by_id

Retrieves a position Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesperson_id
idintegerYesid
includesstringNopossible includes are: person, company separated by space. Receive all includes using the ‘all’ value.

centralstationcrm_people_get_api_people_by_person_id_tags

Retrieves all tags Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesperson_id
perpageintegerNoElements per page, maximum of 250
pageintegerNoRetrieve records of the given page

centralstationcrm_people_get_api_people_by_person_id_tags_by_id

Retrieves a tag Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesperson_id
idintegerYesid

centralstationcrm_people_get_api_people_count

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

Retrieves people matching the search Parameters:
ParameterTypeRequiredDefaultDescription
perpageintegerNoElements per page, maximum of 250
pageintegerNoRetrieve records of the given page
namestringNoRetrieve people by their last name
first_namestringNoRetrieve people by their first name
emailstringNoRetrieve people by their email address (mutually exclusive with phone)
phonestringNoRetrieve people by their phone number (mutually exclusive with email)
includesstringNopossible 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.
methodsstringNoPossible 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.

centralstationcrm_people_get_api_people_stats

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

centralstationcrm_people_post_api_people

creates a person Parameters:
ParameterTypeRequiredDefaultDescription
includesstringNopossible 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.
methodsstringNoPossible 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.
no_logbooleanNoSet to true if you don’t want to generate a activity for the stream.
personobjectNoperson

centralstationcrm_people_post_api_people_by_id_merge

merge another person Parameters:
ParameterTypeRequiredDefaultDescription
idstringYesid
no_logbooleanNoSet to true if you don’t want to generate a activity for the stream.
bodyobjectNoRequest body

centralstationcrm_people_post_api_people_by_person_id_addrs

Creates a basic Addr Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the contact details belong to
addrobjectNoaddr

centralstationcrm_people_post_api_people_by_person_id_assis

Creates an assi of the person Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the assi belong to
assiobjectNoassi

centralstationcrm_people_post_api_people_by_person_id_avatars

create avatar Parameters:
ParameterTypeRequiredDefaultDescription
person_idstringYesperson_id
avatarobjectNoavatar

centralstationcrm_people_post_api_people_by_person_id_contact_details

Creates a basic tel Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the contact details belong to
telobjectNotel

centralstationcrm_people_post_api_people_by_person_id_custom_fields

Creates a basic custom field Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the custom fields belong to
custom_fieldobjectNocustom_field

centralstationcrm_people_post_api_people_by_person_id_historic_events

Creates a basic historic_event Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the historic event belong to
historic_eventobjectNohistoric_event

centralstationcrm_people_post_api_people_by_person_id_positions

Creates a basic position Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesperson_id
positionobjectNoposition

centralstationcrm_people_post_api_people_by_person_id_tags

Creates a basic tag Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesperson_id
tagobjectNotag

centralstationcrm_people_put_api_people_by_id

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

centralstationcrm_people_put_api_people_by_person_id_addrs_by_id

Update a addr Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the addr belong to
idintegerYesID of the addr
addrobjectNoaddr

centralstationcrm_people_put_api_people_by_person_id_assis_by_id

Update a assi Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the assi belong to
idintegerYesID of the assi
assiobjectNoassi

centralstationcrm_people_put_api_people_by_person_id_contact_details_by_id

Update a contact_detail Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the contact details belong to
idintegerYesID of the contact detail
telobjectNotel

centralstationcrm_people_put_api_people_by_person_id_custom_fields_by_id

Update a custom_field Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the custom fields belong to
idintegerYesID of the custom field
custom_fieldobjectNocustom_field

centralstationcrm_people_put_api_people_by_person_id_historic_events_by_id

Update a historic_event Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesID of the person the historic event belong to
idintegerYesID of the historic event
historic_eventobjectNohistoric_event

centralstationcrm_people_put_api_people_by_person_id_positions_by_id

Update a position Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesperson_id
idstringYesid
positionobjectNoposition

centralstationcrm_people_put_api_people_by_person_id_tags_by_id

Update a tag Parameters:
ParameterTypeRequiredDefaultDescription
person_idintegerYesperson_id
idstringYesid
tagobjectNotag