> ## Documentation Index > Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt > Use this file to discover all available pages before exploring further. # centralstationcrm-admin > CentralStationCRM Admin — tags, custom fields, attachments, emails, users, hooks, and settings **Server path:** `/centralstationcrm-admin` | **Type:** Application | **PCID required:** Yes ## Tools | Tool | Description | | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------- | | [`centralstationcrm_admin_delete_api_attachments_by_id`](#centralstationcrm_admin_delete_api_attachments_by_id) | delete attachment | | [`centralstationcrm_admin_delete_api_avatars_by_id`](#centralstationcrm_admin_delete_api_avatars_by_id) | delete avatar | | [`centralstationcrm_admin_delete_api_custom_fields_types_by_id`](#centralstationcrm_admin_delete_api_custom_fields_types_by_id) | Destroy a custom field type | | [`centralstationcrm_admin_delete_api_external_emails_by_external_email_id_attachments_by_id`](#centralstationcrm_admin_delete_api_external_emails_by_external_email_id_attachments_by_id) | delete attachment | | [`centralstationcrm_admin_delete_api_group_calendars_by_id`](#centralstationcrm_admin_delete_api_group_calendars_by_id) | Destroy a group calendar | | [`centralstationcrm_admin_delete_api_hooks_by_id`](#centralstationcrm_admin_delete_api_hooks_by_id) | Destroy a hook | | [`centralstationcrm_admin_get_api_attachments`](#centralstationcrm_admin_get_api_attachments) | Retrieves all attachments | | [`centralstationcrm_admin_get_api_attachments_by_id`](#centralstationcrm_admin_get_api_attachments_by_id) | retrieve attachment | | [`centralstationcrm_admin_get_api_attachments_count`](#centralstationcrm_admin_get_api_attachments_count) | Retrieves total amount and total file size | | [`centralstationcrm_admin_get_api_attachments_search`](#centralstationcrm_admin_get_api_attachments_search) | Retrieves attachments matching the search | | [`centralstationcrm_admin_get_api_avatars`](#centralstationcrm_admin_get_api_avatars) | Retrieves all avatars | | [`centralstationcrm_admin_get_api_avatars_by_id`](#centralstationcrm_admin_get_api_avatars_by_id) | retrieve avatar | | [`centralstationcrm_admin_get_api_avatars_count`](#centralstationcrm_admin_get_api_avatars_count) | Retrieves total amount and total file size | | [`centralstationcrm_admin_get_api_check_connection`](#centralstationcrm_admin_get_api_check_connection) | retrieves the connection status of the api key | | [`centralstationcrm_admin_get_api_contact_details_search`](#centralstationcrm_admin_get_api_contact_details_search) | Retrieves all records matching the contact\_details search | | [`centralstationcrm_admin_get_api_custom_fields_types`](#centralstationcrm_admin_get_api_custom_fields_types) | Retrieves all CustomFieldTypes of the account | | [`centralstationcrm_admin_get_api_custom_fields_types_by_id`](#centralstationcrm_admin_get_api_custom_fields_types_by_id) | Retrieves a custom field type | | [`centralstationcrm_admin_get_api_external_emails`](#centralstationcrm_admin_get_api_external_emails) | Retrieves all external\_emails | | [`centralstationcrm_admin_get_api_external_emails_by_external_email_id_attachments`](#centralstationcrm_admin_get_api_external_emails_by_external_email_id_attachments) | Retrieves all attachments | | [`centralstationcrm_admin_get_api_external_emails_by_external_email_id_attachments_by_id`](#centralstationcrm_admin_get_api_external_emails_by_external_email_id_attachments_by_id) | retrieve attachment | | [`centralstationcrm_admin_get_api_external_emails_by_id`](#centralstationcrm_admin_get_api_external_emails_by_id) | Retrieves a external\_email | | [`centralstationcrm_admin_get_api_external_emails_count`](#centralstationcrm_admin_get_api_external_emails_count) | Retrieves total amount of external\_emails | | [`centralstationcrm_admin_get_api_filter_groups`](#centralstationcrm_admin_get_api_filter_groups) | Retrieves all filter\_groups of the account | | [`centralstationcrm_admin_get_api_filter_groups_by_id`](#centralstationcrm_admin_get_api_filter_groups_by_id) | Retrieves records matching the filter group | | [`centralstationcrm_admin_get_api_filter_groups_by_id_count`](#centralstationcrm_admin_get_api_filter_groups_by_id_count) | Retrieves count of filter\_groups matching records | | [`centralstationcrm_admin_get_api_filter_groups_by_id_ids`](#centralstationcrm_admin_get_api_filter_groups_by_id_ids) | Retrieve ids of records matching the filter group | | [`centralstationcrm_admin_get_api_group_calendars`](#centralstationcrm_admin_get_api_group_calendars) | Retrieves all group calendars | | [`centralstationcrm_admin_get_api_group_calendars_by_id`](#centralstationcrm_admin_get_api_group_calendars_by_id) | Retrieves a group calendar | | [`centralstationcrm_admin_get_api_hooks`](#centralstationcrm_admin_get_api_hooks) | Retrieves all hooks of the account | | [`centralstationcrm_admin_get_api_hooks_by_id`](#centralstationcrm_admin_get_api_hooks_by_id) | Retrieves a hook | | [`centralstationcrm_admin_get_api_search`](#centralstationcrm_admin_get_api_search) | Retrieves search results | | [`centralstationcrm_admin_get_api_tags`](#centralstationcrm_admin_get_api_tags) | Retrieves all tags | | [`centralstationcrm_admin_get_api_tags_list`](#centralstationcrm_admin_get_api_tags_list) | Retrieves all tags | | [`centralstationcrm_admin_get_api_user`](#centralstationcrm_admin_get_api_user) | Retrieve the current API user details | | [`centralstationcrm_admin_get_api_user_maildrop`](#centralstationcrm_admin_get_api_user_maildrop) | Retrieve the current API user maildrop for people and companies | | [`centralstationcrm_admin_get_api_users`](#centralstationcrm_admin_get_api_users) | Retrieves all users of the account | | [`centralstationcrm_admin_get_api_users_by_id`](#centralstationcrm_admin_get_api_users_by_id) | Retrieves a user | | [`centralstationcrm_admin_get_api_users_search`](#centralstationcrm_admin_get_api_users_search) | Retrieves users matching the search | | [`centralstationcrm_admin_post_api_attachments`](#centralstationcrm_admin_post_api_attachments) | create attachment | | [`centralstationcrm_admin_post_api_custom_fields_types`](#centralstationcrm_admin_post_api_custom_fields_types) | Creates a custom field type | | [`centralstationcrm_admin_post_api_external_emails_by_external_email_id_attachments`](#centralstationcrm_admin_post_api_external_emails_by_external_email_id_attachments) | create attachment | | [`centralstationcrm_admin_post_api_group_calendars`](#centralstationcrm_admin_post_api_group_calendars) | Creates a group calendar | | [`centralstationcrm_admin_post_api_hooks`](#centralstationcrm_admin_post_api_hooks) | Creates a hook | | [`centralstationcrm_admin_post_api_tags`](#centralstationcrm_admin_post_api_tags) | Creates a basic tag | | [`centralstationcrm_admin_put_api_custom_fields_types_by_id`](#centralstationcrm_admin_put_api_custom_fields_types_by_id) | Update a custom field type | | [`centralstationcrm_admin_put_api_group_calendars_by_id`](#centralstationcrm_admin_put_api_group_calendars_by_id) | Update a group calendar | *** ## centralstationcrm\_admin\_delete\_api\_attachments\_by\_id delete attachment **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------ | | `id` | string | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_admin\_delete\_api\_avatars\_by\_id delete avatar **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------ | | `id` | string | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_admin\_delete\_api\_custom\_fields\_types\_by\_id Destroy a custom field type **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------ | | `id` | string | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_admin\_delete\_api\_external\_emails\_by\_external\_email\_id\_attachments\_by\_id delete attachment **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ----------------- | | `id` | string | Yes | — | The id value | | `external_email_id` | integer | Yes | — | External Email Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "external_email_id": { "type": "integer", "description": "External Email Id" } }, "required": [ "PCID", "id", "external_email_id" ] } ``` *** ## centralstationcrm\_admin\_delete\_api\_group\_calendars\_by\_id Destroy a group calendar **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------ | | `id` | string | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_admin\_delete\_api\_hooks\_by\_id Destroy a hook **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------ | | `id` | string | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_attachments Retrieves all attachments **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `order` | string | No | — | Ordering of records using one of the following order options: `id-asc`, `id-desc` | | `perpage` | integer | No | — | Elements per page, maximum of 250 | | `page` | integer | No | — | Retrieve records of the given page | | `includes` | string | No | — | possible includes are: user, attachment\_category, comments separated by space. Receive all includes using the 'all' value. | | `methods` | string | No | — | Possible methods are: responsible\_user\_natural\_name, attachment\_category\_name separated by space. Receive all methods using the 'all' value. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order": { "type": "string", "description": "Ordering of records using one of the following order options: `id-asc`, `id-desc`" }, "perpage": { "type": "integer", "description": "Elements per page, maximum of 250" }, "page": { "type": "integer", "description": "Retrieve records of the given page" }, "includes": { "type": "string", "description": "possible includes are: user, attachment_category, comments separated by space. Receive all includes using the 'all' value." }, "methods": { "type": "string", "description": "Possible methods are: responsible_user_natural_name, attachment_category_name separated by space. Receive all methods using the 'all' value." } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_attachments\_by\_id retrieve attachment **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | string | Yes | — | The id value | | `includes` | string | No | — | possible includes are: user, attachment\_category, comments separated by space. Receive all includes using the 'all' value. | | `methods` | string | No | — | Possible methods are: responsible\_user\_natural\_name, attachment\_category\_name separated by space. Receive all methods using the 'all' value. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "includes": { "type": "string", "description": "possible includes are: user, attachment_category, comments separated by space. Receive all includes using the 'all' value." }, "methods": { "type": "string", "description": "Possible methods are: responsible_user_natural_name, attachment_category_name separated by space. Receive all methods using the 'all' value." } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_attachments\_count Retrieves total amount and total file size ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_attachments\_search Retrieves attachments matching the search **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `filename` | string | No | — | find attachments where the filename includes or matches the given input | | `includes` | string | No | — | possible includes are: user, attachment\_category, comments separated by space. Receive all includes using the 'all' value. | | `methods` | string | No | — | Possible methods are: responsible\_user\_natural\_name, attachment\_category\_name separated by space. Receive all methods using the 'all' value. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "filename": { "type": "string", "description": "find attachments where the filename includes or matches the given input" }, "includes": { "type": "string", "description": "possible includes are: user, attachment_category, comments separated by space. Receive all includes using the 'all' value." }, "methods": { "type": "string", "description": "Possible methods are: responsible_user_natural_name, attachment_category_name separated by space. Receive all methods using the 'all' value." } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_avatars Retrieves all avatars **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | --------------------------------------------------------------------------------- | | `order` | string | No | — | Ordering of records using one of the following order options: `id-asc`, `id-desc` | | `perpage` | integer | No | — | Elements per page, maximum of 250 | | `page` | integer | No | — | Retrieve records of the given page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order": { "type": "string", "description": "Ordering of records using one of the following order options: `id-asc`, `id-desc`" }, "perpage": { "type": "integer", "description": "Elements per page, maximum of 250" }, "page": { "type": "integer", "description": "Retrieve records of the given page" } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_avatars\_by\_id retrieve avatar **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------ | | `id` | string | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_avatars\_count Retrieves total amount and total file size ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_check\_connection retrieves the connection status of the api key ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_contact\_details\_search Retrieves all records matching the contact\_details search **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | -------------------------------------------------------- | | `type` | string | No | — | Either people or companies whereas people is the default | | `name` | string | Yes | — | Search term | | `perpage` | integer | No | — | Elements per page, maximum of 250 | | `page` | integer | No | — | Retrieve records of the given page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "type": { "type": "string", "description": "Either people or companies whereas people is the default" }, "name": { "type": "string", "description": "Search term" }, "perpage": { "type": "integer", "description": "Elements per page, maximum of 250" }, "page": { "type": "integer", "description": "Retrieve records of the given page" } }, "required": [ "PCID", "name" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_custom\_fields\_types Retrieves all CustomFieldTypes of the account **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | --------------------------------------------------------------------------------- | | `order` | string | No | — | Ordering of records using one of the following order options: `id-asc`, `id-desc` | | `perpage` | integer | No | — | Elements per page, maximum of 250 | | `page` | integer | No | — | Retrieve records of the given page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order": { "type": "string", "description": "Ordering of records using one of the following order options: `id-asc`, `id-desc`" }, "perpage": { "type": "integer", "description": "Elements per page, maximum of 250" }, "page": { "type": "integer", "description": "Retrieve records of the given page" } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_custom\_fields\_types\_by\_id Retrieves a custom field type **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------ | | `id` | string | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_external\_emails Retrieves all external\_emails **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | --------------------------------------------------------------------------------- | | `order` | string | No | — | Ordering of records using one of the following order options: `id-asc`, `id-desc` | | `perpage` | integer | No | — | Elements per page, maximum of 250 | | `page` | integer | No | — | Retrieve records of the given page | | `includes` | string | No | — | possible option: comments | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order": { "type": "string", "description": "Ordering of records using one of the following order options: `id-asc`, `id-desc`" }, "perpage": { "type": "integer", "description": "Elements per page, maximum of 250" }, "page": { "type": "integer", "description": "Retrieve records of the given page" }, "includes": { "type": "string", "description": "possible option: comments" } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_external\_emails\_by\_external\_email\_id\_attachments Retrieves all attachments **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `includes` | string | No | — | possible includes are: user, attachment\_category, comments separated by space. Receive all includes using the 'all' value. | | `methods` | string | No | — | Possible methods are: responsible\_user\_natural\_name, attachment\_category\_name separated by space. Receive all methods using the 'all' value. | | `order` | string | No | — | Ordering of records using one of the following order options: `id-asc`, `id-desc` | | `perpage` | integer | No | — | Elements per page, maximum of 250 | | `page` | integer | No | — | Retrieve records of the given page | | `external_email_id` | integer | Yes | — | External Email Id | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "includes": { "type": "string", "description": "possible includes are: user, attachment_category, comments separated by space. Receive all includes using the 'all' value." }, "methods": { "type": "string", "description": "Possible methods are: responsible_user_natural_name, attachment_category_name separated by space. Receive all methods using the 'all' value." }, "order": { "type": "string", "description": "Ordering of records using one of the following order options: `id-asc`, `id-desc`" }, "perpage": { "type": "integer", "description": "Elements per page, maximum of 250" }, "page": { "type": "integer", "description": "Retrieve records of the given page" }, "external_email_id": { "type": "integer", "description": "External Email Id" } }, "required": [ "PCID", "external_email_id" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_external\_emails\_by\_external\_email\_id\_attachments\_by\_id retrieve attachment **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | string | Yes | — | The id value | | `external_email_id` | integer | Yes | — | External Email Id | | `includes` | string | No | — | possible includes are: user, attachment\_category, comments separated by space. Receive all includes using the 'all' value. | | `methods` | string | No | — | Possible methods are: responsible\_user\_natural\_name, attachment\_category\_name separated by space. Receive all methods using the 'all' value. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "external_email_id": { "type": "integer", "description": "External Email Id" }, "includes": { "type": "string", "description": "possible includes are: user, attachment_category, comments separated by space. Receive all includes using the 'all' value." }, "methods": { "type": "string", "description": "Possible methods are: responsible_user_natural_name, attachment_category_name separated by space. Receive all methods using the 'all' value." } }, "required": [ "PCID", "id", "external_email_id" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_external\_emails\_by\_id Retrieves a external\_email **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------- | | `id` | string | Yes | — | The id value | | `includes` | string | No | — | possible option: comments | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "includes": { "type": "string", "description": "possible option: comments" } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_external\_emails\_count Retrieves total amount of external\_emails ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_filter\_groups Retrieves all filter\_groups of the account **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `order` | string | No | — | Ordering of records using one of the following order options: `abc-asc`, `abc-desc`, `new-asc`, `new-desc`, `update-asc`, `update-desc`, `activity-asc`, `activity-desc` | | `perpage` | integer | No | — | Elements per page, maximum of 250 | | `page` | integer | No | — | Retrieve records of the given page | | `filter` | object | No | — | Optionally submit one of the filtergroups 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' }`). | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order": { "type": "string", "description": "Ordering of records using one of the following order options: `abc-asc`, `abc-desc`, `new-asc`, `new-desc`, `update-asc`, `update-desc`, `activity-asc`, `activity-desc`" }, "perpage": { "type": "integer", "description": "Elements per page, maximum of 250" }, "page": { "type": "integer", "description": "Retrieve records of the given page" }, "filter": { "type": "object", "description": "Optionally submit one of the filtergroups 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' }`)." } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_filter\_groups\_by\_id Retrieves records matching the filter group **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `id` | integer | Yes | — | The id value | | `includes` | string | No | — | available includes depend on the model\_type of the FilterGroup and can be found in the APIdocs of the object (e.g. `Person`, `Company`, `Deal` or `Project`. Includes may be separated by space. Receive all includes using the `all` value. | | `methods` | string | No | — | available methods depend on the model\_type of the FilterGroup and can be found in the APIdocs of the object (e.g. `Person`, `Company`, `Deal` or `Project`. Methods may be separated by space. Receive all methods using the `all` value. | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The id value" }, "includes": { "type": "string", "description": "available includes depend on the model_type of the FilterGroup and can be found in the APIdocs of the object (e.g. `Person`, `Company`, `Deal` or `Project`. Includes may be separated by space. Receive all includes using the `all` value." }, "methods": { "type": "string", "description": "available methods depend on the model_type of the FilterGroup and can be found in the APIdocs of the object (e.g. `Person`, `Company`, `Deal` or `Project`. Methods may be separated by space. Receive all methods using the `all` value." } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_filter\_groups\_by\_id\_count Retrieves count of filter\_groups matching records **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------ | | `id` | integer | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_filter\_groups\_by\_id\_ids Retrieve ids of records matching the filter group **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ------------ | | `id` | integer | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "integer", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_group\_calendars Retrieves all group calendars **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | --------------------------------------------------------------------------------- | | `order` | string | No | — | Ordering of records using one of the following order options: `id-asc`, `id-desc` | | `perpage` | integer | No | — | Elements per page, maximum of 250 | | `page` | integer | No | — | Retrieve records of the given page | | `includes` | string | No | — | possible option: cal\_events | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order": { "type": "string", "description": "Ordering of records using one of the following order options: `id-asc`, `id-desc`" }, "perpage": { "type": "integer", "description": "Elements per page, maximum of 250" }, "page": { "type": "integer", "description": "Retrieve records of the given page" }, "includes": { "type": "string", "description": "possible option: cal_events" } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_group\_calendars\_by\_id Retrieves a group calendar **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ---------------------------- | | `id` | string | Yes | — | The id value | | `includes` | string | No | — | possible option: cal\_events | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "includes": { "type": "string", "description": "possible option: cal_events" } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_hooks Retrieves all hooks of the account **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------- | -------- | ------- | ---------------------------------- | | `perpage` | integer | No | — | Elements per page, maximum of 250 | | `page` | integer | No | — | Retrieve records of the given page | | `includes` | string | No | — | possible option: filter\_groups | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "perpage": { "type": "integer", "description": "Elements per page, maximum of 250" }, "page": { "type": "integer", "description": "Retrieve records of the given page" }, "includes": { "type": "string", "description": "possible option: filter_groups" } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_hooks\_by\_id Retrieves a hook **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------- | | `id` | string | Yes | — | The id value | | `includes` | string | No | — | possible option: filter\_groups | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "includes": { "type": "string", "description": "possible option: filter_groups" } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_search Retrieves search results **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | -------------- | | `term` | string | No | — | The term value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "term": { "type": "string", "description": "The term value" } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_tags Retrieves all tags **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `order` | string | No | — | Ordering of records using one of the following order options: `id-asc`, `id-desc` | | `perpage` | integer | No | — | Elements per page, maximum of 250 | | `page` | integer | No | — | Retrieve records of the given page | | `filter` | object | No | — | Optionally submit one of the taggings 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' }`). | | `person_id` | integer | No | — | Optional ID of the desired person | | `company_id` | integer | No | — | Optional ID of the desired company | | `deal_id` | integer | No | — | Optional ID of the desired deal | | `project_id` | integer | No | — | Optional ID of the desired project | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "order": { "type": "string", "description": "Ordering of records using one of the following order options: `id-asc`, `id-desc`" }, "perpage": { "type": "integer", "description": "Elements per page, maximum of 250" }, "page": { "type": "integer", "description": "Retrieve records of the given page" }, "filter": { "type": "object", "description": "Optionally submit one of the taggings 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' }`)." }, "person_id": { "type": "integer", "description": "Optional ID of the desired person" }, "company_id": { "type": "integer", "description": "Optional ID of the desired company" }, "deal_id": { "type": "integer", "description": "Optional ID of the desired deal" }, "project_id": { "type": "integer", "description": "Optional ID of the desired project" } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_tags\_list Retrieves all tags **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ---------------------------------- | | `perpage` | integer | No | — | Elements per page, maximum of 250 | | `page` | integer | No | — | Retrieve records of the given page | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "perpage": { "type": "integer", "description": "Elements per page, maximum of 250" }, "page": { "type": "integer", "description": "Retrieve records of the given page" } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_user Retrieve the current API user details ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_user\_maildrop Retrieve the current API user maildrop for people and companies ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_users Retrieves all users of the account **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | --------------------------------------------------------- | | `perpage` | integer | No | — | Elements per page, maximum of 250 | | `page` | integer | No | — | Retrieve records of the given page | | `active` | string | No | — | optional parameter to only include currently active users | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "perpage": { "type": "integer", "description": "Elements per page, maximum of 250" }, "page": { "type": "integer", "description": "Retrieve records of the given page" }, "active": { "type": "string", "description": "optional parameter to only include currently active users" } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_users\_by\_id Retrieves a user **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------ | | `id` | string | Yes | — | The id value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_admin\_get\_api\_users\_search Retrieves users matching the search **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------- | -------- | ------- | ---------------------------------- | | `perpage` | integer | No | — | Elements per page, maximum of 250 | | `page` | integer | No | — | Retrieve records of the given page | | `first` | string | No | — | Retrieve users by their first name | | `name` | string | No | — | Retrieve users by their last name | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "perpage": { "type": "integer", "description": "Elements per page, maximum of 250" }, "page": { "type": "integer", "description": "Retrieve records of the given page" }, "first": { "type": "string", "description": "Retrieve users by their first name" }, "name": { "type": "string", "description": "Retrieve users by their last name" } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_post\_api\_attachments create attachment **Parameters:** | Parameter | Type | Required | Default | Description | | ------------ | ------ | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `includes` | string | No | — | possible includes are: user, attachment\_category, comments separated by space. Receive all includes using the 'all' value. | | `methods` | string | No | — | Possible methods are: responsible\_user\_natural\_name, attachment\_category\_name separated by space. Receive all methods using the 'all' value. | | `attachment` | object | No | — | The attachment value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "includes": { "type": "string", "description": "possible includes are: user, attachment_category, comments separated by space. Receive all includes using the 'all' value." }, "methods": { "type": "string", "description": "Possible methods are: responsible_user_natural_name, attachment_category_name separated by space. Receive all methods using the 'all' value." }, "attachment": { "description": "The attachment value" } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_post\_api\_custom\_fields\_types Creates a custom field type **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ------------------ | | `custom_fields_type` | object | No | — | Custom Fields Type | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "custom_fields_type": { "type": "object", "description": "Custom Fields Type", "properties": { "position": { "type": "integer", "description": "The position value" }, "category": { "type": "string", "description": "can be Person, Company, Deal or Project" }, "ftype": { "type": "string", "description": "can be string, select, decimal, date or url" }, "name": { "type": "string", "description": "The name value" }, "options": { "type": "array", "items": { "type": "string" }, "description": "options for CustomFieldTypes with the ftype select" } }, "required": [ "position", "category", "ftype", "name", "options" ] } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_post\_api\_external\_emails\_by\_external\_email\_id\_attachments create attachment **Parameters:** | Parameter | Type | Required | Default | Description | | ------------------- | ------- | -------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | | `includes` | string | No | — | possible includes are: user, attachment\_category, comments separated by space. Receive all includes using the 'all' value. | | `methods` | string | No | — | Possible methods are: responsible\_user\_natural\_name, attachment\_category\_name separated by space. Receive all methods using the 'all' value. | | `external_email_id` | integer | Yes | — | External Email Id | | `attachment` | object | No | — | The attachment value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "includes": { "type": "string", "description": "possible includes are: user, attachment_category, comments separated by space. Receive all includes using the 'all' value." }, "methods": { "type": "string", "description": "Possible methods are: responsible_user_natural_name, attachment_category_name separated by space. Receive all methods using the 'all' value." }, "external_email_id": { "type": "integer", "description": "External Email Id" }, "attachment": { "description": "The attachment value" } }, "required": [ "PCID", "external_email_id" ] } ``` *** ## centralstationcrm\_admin\_post\_api\_group\_calendars Creates a group calendar **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | -------------- | | `group_calendar` | object | No | — | Group Calendar | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "group_calendar": { "type": "object", "description": "Group Calendar", "properties": { "read_only": { "type": "boolean", "description": "some calendars will be added on account creation an cannot be removed or renamed" }, "name": { "type": "string", "description": "The name value" }, "color_type": { "type": "string", "description": "can be one of the following: one two three four five six seven eight nine ten eleven twelve" } }, "required": [ "read_only", "name", "color_type" ] } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_post\_api\_hooks Creates a hook **Parameters:** | Parameter | Type | Required | Default | Description | | ---------- | ------ | -------- | ------- | ------------------------------- | | `includes` | string | No | — | possible option: filter\_groups | | `hook` | object | No | — | The hook value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "includes": { "type": "string", "description": "possible option: filter_groups" }, "hook": { "type": "object", "description": "The hook value", "properties": { "model": { "type": "string", "description": "Object type to be notified about (either Person, Company, Deal, Project or Protocol).", "enum": [ "Person", "Company", "Deal", "Project", "Protocol" ] }, "event": { "type": "string", "description": "Activity that shall trigger the hook (either create, update or destroy).", "enum": [ "create", "update", "destroy" ] }, "state": { "type": "string", "description": "Indicating if the hook is enabled or not (either active or disabled).", "enum": [ "active", "disabled" ] }, "target_url": { "type": "string", "description": "URL to which the webhook should be sent." }, "object_type": { "type": "string", "description": "Data structure of the webhook (either nested, api or lean).", "enum": [ "nested", "api", "lean", "hook_with_structure_and_record" ] }, "includes": { "type": "string", "description": "Only relevant for the 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 ...)." }, "methods": { "type": "array", "items": { "type": "string" }, "description": "Methods depending on the hook model, e.g. `salutation_official` for Person." }, "hook_type": { "type": "string", "description": "We currently only support `url` as hook type.", "enum": [ "url" ] }, "failed": { "type": "integer", "description": "Number of failed attempts to deliver a webhook to the target_url." }, "failed_at": { "type": "string", "description": "The last time a webhook could not be delivered to the target_url." } }, "required": [ "model", "event", "target_url", "object_type", "hook_type" ] } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_post\_api\_tags Creates a basic tag **Parameters:** | Parameter | Type | Required | Default | Description | | --------- | ------ | -------- | ------- | ------------- | | `tag` | object | No | — | The tag value | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "tag": { "type": "object", "description": "The tag value", "properties": { "attachable_id": { "type": "integer", "description": "id of the record the tag belongs to (e.g. a person). Will be auto set when using routes such as /people/:id with nested attributes." }, "attachable_type": { "type": "string", "description": "must be Person, Company, Deal, Company. Will be auto set when using routes such as /people/:id with nested attributes." }, "name": { "type": "string", "description": "The name value" }, "api_input": { "type": "boolean", "description": "States weather or not the tag has been added via the API or some sort of integration." } }, "required": [ "attachable_id", "attachable_type", "name" ] } }, "required": [ "PCID" ] } ``` *** ## centralstationcrm\_admin\_put\_api\_custom\_fields\_types\_by\_id Update a custom field type **Parameters:** | Parameter | Type | Required | Default | Description | | -------------------- | ------ | -------- | ------- | ------------------ | | `id` | string | Yes | — | The id value | | `custom_fields_type` | object | No | — | Custom Fields Type | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "custom_fields_type": { "type": "object", "description": "Custom Fields Type", "properties": { "position": { "type": "integer", "description": "The position value" }, "category": { "type": "string", "description": "can be Person, Company, Deal or Project" }, "ftype": { "type": "string", "description": "can be string, select, decimal, date or url" }, "name": { "type": "string", "description": "The name value" }, "options": { "type": "array", "items": { "type": "string" }, "description": "options for CustomFieldTypes with the ftype select" } }, "required": [ "position", "category", "ftype", "name", "options" ] } }, "required": [ "PCID", "id" ] } ``` *** ## centralstationcrm\_admin\_put\_api\_group\_calendars\_by\_id Update a group calendar **Parameters:** | Parameter | Type | Required | Default | Description | | ---------------- | ------ | -------- | ------- | -------------- | | `id` | string | Yes | — | The id value | | `group_calendar` | object | No | — | Group Calendar | ```json theme={null} { "type": "object", "properties": { "PCID": { "type": "string", "description": "Pink Connect ID for the authenticated connection" }, "id": { "type": "string", "description": "The id value" }, "group_calendar": { "type": "object", "description": "Group Calendar", "properties": { "read_only": { "type": "boolean", "description": "some calendars will be added on account creation an cannot be removed or renamed" }, "name": { "type": "string", "description": "The name value" }, "color_type": { "type": "string", "description": "can be one of the following: one two three four five six seven eight nine ten eleven twelve" } }, "required": [ "read_only", "name", "color_type" ] } }, "required": [ "PCID", "id" ] } ```