### GET /api/projects/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Deal-nested/post_api_deals__deal_id__protocols__protocol_id__attachments Retrieves a project. ```APIDOC ## GET /api/projects/{id} ### Description Retrieves a project. ### Method GET ### Endpoint /api/projects/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the project. ``` -------------------------------- ### GET /api/deals Source: https://api.centralstationcrm.net/api-docs/index.html#/Company-nested/get_api_companies__company_id__avatars__id_ Retrieves all deals. ```APIDOC ## GET /api/deals ### Description Retrieves all deals. ### Method GET ### Endpoint /api/deals ``` -------------------------------- ### GET /api/deals Source: https://api.centralstationcrm.net/api-docs/index.html#/Company-nested/put_api_companies__company_id__addrs__id_ Retrieves all deals. ```APIDOC ## GET /api/deals ### Description Retrieves all deals. ### Method GET ### Endpoint /api/deals ``` -------------------------------- ### GET /api/protocols Source: https://api.centralstationcrm.net/api-docs/index.html#/CalEvent/put_api_cal_events__id_ Retrieves all protocols. ```APIDOC ## GET /api/protocols ### Description Retrieves all protocols. ### Method GET ### Endpoint /api/protocols ``` -------------------------------- ### GET /api/tags/list Source: https://api.centralstationcrm.net/api-docs/index.html#/Tag/get_api_people__person_id__tags Retrieves all tags. ```APIDOC ## GET /api/tags/list ### Description Retrieves all tags. ### Method GET ### Endpoint /api/tags/list ``` -------------------------------- ### GET /api/tags Source: https://api.centralstationcrm.net/api-docs/index.html#/Tag/get_api_people__person_id__tags Retrieves all tags. ```APIDOC ## GET /api/tags ### Description Retrieves all tags. ### Method GET ### Endpoint /api/tags ``` -------------------------------- ### GET /api/projects/count Source: https://api.centralstationcrm.net/api-docs/index.html#/Deal-nested/post_api_deals__deal_id__protocols__protocol_id__attachments Retrieves the total amount of projects. ```APIDOC ## GET /api/projects/count ### Description Retrieves the total amount of projects. ### Method GET ### Endpoint /api/projects/count ``` -------------------------------- ### GET /api/attachments/ Source: https://api.centralstationcrm.net/api-docs/index.html#/Attachment/get_api_attachments_search Retrieves all attachments. ```APIDOC ## GET /api/attachments/ ### Description Retrieves all attachments. ### Method GET ### Endpoint /api/attachments/ ``` -------------------------------- ### GET /api/deal_types Source: https://api.centralstationcrm.net/api-docs/index.html#/Deal-nested/post_api_deals__deal_id__protocols__protocol_id__attachments Retrieves all deal types of the account. ```APIDOC ## GET /api/deal_types ### Description Retrieves all deal types of the account. ### Method GET ### Endpoint /api/deal_types ``` -------------------------------- ### GET /api/attachments/ Source: https://api.centralstationcrm.net/api-docs/index.html#/Addr/get_api_companies__company_id__addrs__id_ Retrieves all attachments. ```APIDOC ## GET /api/attachments/ ### Description Retrieves all attachments. ### Method GET ### Endpoint /api/attachments/ ``` -------------------------------- ### GET /api/tasks Source: https://api.centralstationcrm.net/api-docs/index.html#/Tag/get_api_people__person_id__tags Retrieves all tasks of the account. ```APIDOC ## GET /api/tasks ### Description Retrieves all tasks of the account. ### Method GET ### Endpoint /api/tasks ``` -------------------------------- ### GET /api/activities Source: https://api.centralstationcrm.net/api-docs/index.html#/Project-nested/get_api_projects__project_id__maildrop Retrieves activities for the record. ```APIDOC ## GET /api/activities ### Description Retrieves activities for the record. ### Method GET ### Endpoint /api/activities ``` -------------------------------- ### GET /api/avatars/ Source: https://api.centralstationcrm.net/api-docs/index.html#/Attachment/get_api_people__person_id__protocols__protocol_id__attachments_search Retrieves all avatars. ```APIDOC ## GET /api/avatars/ ### Description Retrieves all avatars. ### Method GET ### Endpoint /api/avatars/ ### Response #### Success Response (200) (No response example provided) ``` -------------------------------- ### GET /api/hooks Source: https://api.centralstationcrm.net/api-docs/index.html#/Hook/post_api_hooks Retrieves all hooks of the account. ```APIDOC ## GET /api/hooks ### Description Retrieves all hooks of the account. ### Method GET ### Endpoint /api/hooks ``` -------------------------------- ### GET /api/projects/stats Source: https://api.centralstationcrm.net/api-docs/index.html#/Project-nested/get_api_projects__project_id__maildrop Retrieves key information of projects. ```APIDOC ## GET /api/projects/stats ### Description Retrieves key information of projects. ### Method GET ### Endpoint /api/projects/stats ``` -------------------------------- ### GET /api/companies Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/post_api_people__person_id__positions Retrieves all companies. ```APIDOC ## GET /api/companies ### Description Retrieves all companies. ### Method GET ### Endpoint /api/companies ``` -------------------------------- ### GET /api/deals/stats Source: https://api.centralstationcrm.net/api-docs/index.html#/Company-nested/post_api_companies__company_id__contact_details Retrieves key information about deals. ```APIDOC ## GET /api/deals/stats ### Description Retrieves key information about deals. ### Method GET ### Endpoint /api/deals/stats ``` -------------------------------- ### GET /api/people Source: https://api.centralstationcrm.net/api-docs/index.html#/Person Retrieves all people. ```APIDOC ## GET /api/people ### Description Retrieves all people. ### Method GET ### Endpoint /api/people ``` -------------------------------- ### GET /api/projects/count Source: https://api.centralstationcrm.net/api-docs/index.html#/Project-nested/get_api_projects__project_id__maildrop Retrieves the total amount of projects. ```APIDOC ## GET /api/projects/count ### Description Retrieves total amount of projects. ### Method GET ### Endpoint /api/projects/count ``` -------------------------------- ### GET /api/protocols/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/CalEvent/put_api_cal_events__id_ Retrieves a protocol. ```APIDOC ## GET /api/protocols/{id} ### Description Retrieves a protocol. ### Method GET ### Endpoint /api/protocols/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the protocol. ``` -------------------------------- ### GET /api/users Source: https://api.centralstationcrm.net/api-docs/index.html#/Tag/get_api_people__person_id__tags Retrieves all users of the account. ```APIDOC ## GET /api/users ### Description Retrieves all users of the account. ### Method GET ### Endpoint /api/users ``` -------------------------------- ### GET /api/deal_types/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Deal-nested/post_api_deals__deal_id__protocols__protocol_id__attachments Retrieves a deal type with its stages. ```APIDOC ## GET /api/deal_types/{id} ### Description Retrieves a deal type with its stages. ### Method GET ### Endpoint /api/deal_types/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the deal type. ``` -------------------------------- ### GET /api/comments Source: https://api.centralstationcrm.net/api-docs/index.html#/Tag/get_api_people__person_id__tags Retrieves all comments of the account. ```APIDOC ## GET /api/comments ### Description Retrieves all comments of the account. ### Method GET ### Endpoint /api/comments ``` -------------------------------- ### GET /api/projects/search Source: https://api.centralstationcrm.net/api-docs/index.html#/Project-nested/get_api_projects__project_id__maildrop Retrieves projects matching the search criteria. ```APIDOC ## GET /api/projects/search ### Description Retrieves projects matching the search. ### Method GET ### Endpoint /api/projects/search ``` -------------------------------- ### GET /api/projects Source: https://api.centralstationcrm.net/api-docs/index.html#/Deal/get_api_deals__id_ Retrieves all projects. This endpoint returns a list of all projects in the system. ```APIDOC ## GET /api/projects ### Description Retrieves all projects. ### Method GET ### Endpoint /api/projects ``` -------------------------------- ### GET /api/people/{person_id}/positions Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/delete_api_people__person_id__assis__id_ Retrieves all positions. ```APIDOC ## GET /api/people/{person_id}/positions ### Description Retrieves all positions. ### Method GET ### Endpoint /api/people/{person_id}/positions ### Parameters #### Path Parameters - **person_id** - Required - The ID of the person. ``` -------------------------------- ### GET /api/deals/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Company-nested/get_api_companies__company_id__avatars__id_ Retrieves a specific deal. ```APIDOC ## GET /api/deals/{id} ### Description Retrieves a specific deal. ### Method GET ### Endpoint /api/deals/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the deal. ``` -------------------------------- ### POST /api/people/{person_id}/addrs request body example Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/post_api_people__person_id__addrs Example JSON payload for creating a basic Addr for a person. The addr object requires attachable_type, attachable_id, street, zip, city, state_code, country_code, primary, atype, and api_input fields. person_id is a required path parameter. ```json { "addr": { "attachable_type": "Person", "attachable_id": 0, "street": "Herderstraße 70", "zip": "50931", "city": "Cologne", "state_code": "NW", "country_code": "DE", "primary": true, "atype": "work", "api_input": false } } ``` -------------------------------- ### GET /api/deals/count Source: https://api.centralstationcrm.net/api-docs/index.html#/Company-nested/get_api_companies__company_id__avatars__id_ Retrieves the total amount of deals. ```APIDOC ## GET /api/deals/count ### Description Retrieves the total amount of deals. ### Method GET ### Endpoint /api/deals/count ``` -------------------------------- ### GET /api/users/search Source: https://api.centralstationcrm.net/api-docs/index.html#/Tag/get_api_people__person_id__tags Retrieves users matching the search. ```APIDOC ## GET /api/users/search ### Description Retrieves users matching the search. ### Method GET ### Endpoint /api/users/search ``` -------------------------------- ### GET /api/protocols/count Source: https://api.centralstationcrm.net/api-docs/index.html#/Protocol-nested/get_api_companies__company_id__protocols__protocol_id__attachments__id_ Retrieves the total amount of protocols. ```APIDOC ## GET /api/protocols/count ### Description Retrieves the total amount of protocols. ### Method GET ### Endpoint /api/protocols/count ``` -------------------------------- ### GET /api/protocols Source: https://api.centralstationcrm.net/api-docs/index.html#/Protocol/delete_api_protocols__id_ Retrieves all protocols. This endpoint returns a list of all protocols stored in the system. ```APIDOC ## GET /api/protocols ### Description Retrieves all protocols. ### Method GET ### Endpoint /api/protocols ### Response #### Success Response (200) - List of protocols #### Response Example ```json [ { "id": 1, "subject": "Meeting notes", "body": "Discussed project timeline" } ] ``` ``` -------------------------------- ### GET /api/people/{person_id}/tags/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/post_api_people__person_id__assis Retrieves a tag. Use this endpoint to get details of a specific tag associated with a person. ```APIDOC ## GET /api/people/{person_id}/tags/{id} ### Description Retrieves a tag. Use this endpoint to get details of a specific tag associated with a person. ### Method GET ### Endpoint /api/people/{person_id}/tags/{id} ### Parameters #### Path Parameters - **person_id** (string) - Required - The ID of the person. - **id** (string) - Required - The ID of the tag to retrieve. ``` -------------------------------- ### GET /api/projects/{project_id}/protocols/{protocol_id}/attachments Source: https://api.centralstationcrm.net/api-docs/index.html#/Deal-nested/post_api_deals__deal_id__protocols__protocol_id__attachments Retrieves all attachments for a specific protocol under a project. ```APIDOC ## GET /api/projects/{project_id}/protocols/{protocol_id}/attachments ### Description Retrieves all attachments for a specific protocol under a project. ### Method GET ### Endpoint /api/projects/{project_id}/protocols/{protocol_id}/attachments ### Parameters #### Path Parameters - **project_id** (string) - Required - The ID of the project. - **protocol_id** (string) - Required - The ID of the protocol. ``` -------------------------------- ### GET /api/people/{person_id}/positions/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/post_api_people__person_id__assis Retrieves a specific position. Use this endpoint to get details of a single position associated with a person. ```APIDOC ## GET /api/people/{person_id}/positions/{id} ### Description Retrieves a specific position. Use this endpoint to get details of a single position associated with a person. ### Method GET ### Endpoint /api/people/{person_id}/positions/{id} ### Parameters #### Path Parameters - **person_id** (string) - Required - The ID of the person. - **id** (string) - Required - The ID of the position to retrieve. ``` -------------------------------- ### GET /api/protocols/count Source: https://api.centralstationcrm.net/api-docs/index.html#/CalEvent-nested/get_api_cal_events__cal_event_id__cal_event_attendees Retrieves the total amount of protocols. ```APIDOC ## GET /api/protocols/count ### Description Retrieves the total amount of protocols. ### Method GET ### Endpoint /api/protocols/count ### Response #### Success Response (200) - **count** (integer) - The total number of protocols. #### Response Example { "count": 0 } ``` -------------------------------- ### GET /api/deals/search Source: https://api.centralstationcrm.net/api-docs/index.html#/Company-nested/get_api_companies__company_id__avatars__id_ Retrieves deals matching the search criteria. ```APIDOC ## GET /api/deals/search ### Description Retrieves deals matching the search criteria. ### Method GET ### Endpoint /api/deals/search ``` -------------------------------- ### PUT /api/projects/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Deal-nested/post_api_deals__deal_id__protocols__protocol_id__attachments Updates a project. ```APIDOC ## PUT /api/projects/{id} ### Description Updates a project. ### Method PUT ### Endpoint /api/projects/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the project. ``` -------------------------------- ### POST /api/projects Source: https://api.centralstationcrm.net/api-docs/index.html#/Deal/get_api_deals__id_ Creates a basic project. This endpoint allows you to create a new project with basic information. ```APIDOC ## POST /api/projects ### Description Creates a basic project. ### Method POST ### Endpoint /api/projects ``` -------------------------------- ### GET /api/people/stats Source: https://api.centralstationcrm.net/api-docs/index.html#/Person Retrieves key information of people. ```APIDOC ## GET /api/people/stats ### Description Retrieves key information of people. ### Method GET ### Endpoint /api/people/stats ``` -------------------------------- ### POST /api/tasks Source: https://api.centralstationcrm.net/api-docs/index.html#/Tag/get_api_people__person_id__tags Creates a task. ```APIDOC ## POST /api/tasks ### Description Creates a task. ### Method POST ### Endpoint /api/tasks ``` -------------------------------- ### GET /api/avatars/ Source: https://api.centralstationcrm.net/api-docs/index.html#/Attachment/get_api_people__person_id__protocols__protocol_id__attachments__id_ Retrieves all avatars. ```APIDOC ## GET /api/avatars/ ### Description Retrieves all avatars. ### Method GET ### Endpoint /api/avatars/ ``` -------------------------------- ### GET /api/people/{person_id}/assis/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/delete_api_people__person_id__assis__id_ Retrieves the assi. ```APIDOC ## GET /api/people/{person_id}/assis/{id} ### Description Retrieves the assi. ### Method GET ### Endpoint /api/people/{person_id}/assis/{id} ### Parameters #### Path Parameters - **person_id** - Required - The ID of the person. - **id** - Required - The ID of the assi. ``` -------------------------------- ### POST /api/protocols Source: https://api.centralstationcrm.net/api-docs/index.html#/CalEvent/put_api_cal_events__id_ Creates a protocol. ```APIDOC ## POST /api/protocols ### Description Creates a protocol. ### Method POST ### Endpoint /api/protocols ``` -------------------------------- ### POST /api/deals Source: https://api.centralstationcrm.net/api-docs/index.html#/Company-nested/get_api_companies__company_id__avatars__id_ Creates a basic deal. ```APIDOC ## POST /api/deals ### Description Creates a basic deal. ### Method POST ### Endpoint /api/deals ``` -------------------------------- ### POST /api/people/{person_id}/addrs Source: https://api.centralstationcrm.net/api-docs/index.html#/Person Creates a basic Addr. ```APIDOC ## POST /api/people/{person_id}/addrs ### Description Creates a basic Addr. ### Method POST ### Endpoint /api/people/{person_id}/addrs ``` -------------------------------- ### POST /api/deals/{deal_id}/protocols/{protocol_id}/attachments Source: https://api.centralstationcrm.net/api-docs/index.html#/CalEventAttendee/delete_api_cal_events__cal_event_id__cal_event_attendees__id_ Creates an attachment for a protocol under a deal. ```APIDOC ## POST /api/deals/{deal_id}/protocols/{protocol_id}/attachments ### Description Creates an attachment for a protocol under a deal. ### Method POST ### Endpoint /api/deals/{deal_id}/protocols/{protocol_id}/attachments ### Parameters #### Path Parameters - **deal_id** (integer) - Required - The ID of the deal. - **protocol_id** (integer) - Required - The ID of the protocol. ``` -------------------------------- ### GET /api/protocols/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Protocol/get_api_protocols_count Retrieves a protocol by its unique identifier. ```APIDOC ## GET /api/protocols/{id} ### Description Retrieves a protocol. ### Method GET ### Endpoint /api/protocols/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The unique identifier of the protocol. ``` -------------------------------- ### POST /api/people/{person_id}/positions Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/delete_api_people__person_id__assis__id_ Creates a basic position. ```APIDOC ## POST /api/people/{person_id}/positions ### Description Creates a basic position. ### Method POST ### Endpoint /api/people/{person_id}/positions ### Parameters #### Path Parameters - **person_id** - Required - The ID of the person. ``` -------------------------------- ### POST /api/companies Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/post_api_people__person_id__positions Creates a basic company. ```APIDOC ## POST /api/companies ### Description Creates a basic company. ### Method POST ### Endpoint /api/companies ``` -------------------------------- ### POST /api/tags Source: https://api.centralstationcrm.net/api-docs/index.html#/Tag/get_api_people__person_id__tags Creates a basic tag. ```APIDOC ## POST /api/tags ### Description Creates a basic tag. ### Method POST ### Endpoint /api/tags ``` -------------------------------- ### GET /api/deals/{deal_id}/maildrop Source: https://api.centralstationcrm.net/api-docs/index.html#/Deal-nested/post_api_deals__deal_id__protocols__protocol_id__attachments Retrieves the maildrop for a specific deal. ```APIDOC ## GET /api/deals/{deal_id}/maildrop ### Description Retrieves the maildrop for a specific deal. ### Method GET ### Endpoint /api/deals/{deal_id}/maildrop ### Parameters #### Path Parameters - **deal_id** (string) - Required - The ID of the deal. ``` -------------------------------- ### GET /api/projects/{project_id}/protocols/{protocol_id}/attachments Source: https://api.centralstationcrm.net/api-docs/index.html#/Attachment/get_api_people__person_id__protocols__protocol_id__attachments_search Retrieves all attachments for a protocol of a project. ```APIDOC ## GET /api/projects/{project_id}/protocols/{protocol_id}/attachments ### Description Retrieves all attachments for a protocol of a project. ### Method GET ### Endpoint /api/projects/{project_id}/protocols/{protocol_id}/attachments ### Parameters #### Path Parameters - **project_id** (integer) - Required - The ID of the project. - **protocol_id** (integer) - Required - The ID of the protocol. ### Response #### Success Response (200) (No response example provided) ``` -------------------------------- ### GET /api/companies/{company_id}/addrs/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Company-nested/put_api_companies__company_id__addrs__id_ Retrieves the addr. ```APIDOC ## GET /api/companies/{company_id}/addrs/{id} ### Description Retrieves the addr. ### Method GET ### Endpoint /api/companies/{company_id}/addrs/{id} ### Parameters #### Path Parameters - **company_id** (string) - Required - The ID of the company. - **id** (string) - Required - The ID of the addr. ``` -------------------------------- ### GET /api/people/{person_id}/tags/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/delete_api_people__person_id__assis__id_ Retrieves a tag. ```APIDOC ## GET /api/people/{person_id}/tags/{id} ### Description Retrieves a tag. ### Method GET ### Endpoint /api/people/{person_id}/tags/{id} ### Parameters #### Path Parameters - **person_id** - Required - The ID of the person. - **id** - Required - The ID of the tag. ``` -------------------------------- ### GET /api/user Source: https://api.centralstationcrm.net/api-docs/index.html#/Person Retrieve the current API user details. ```APIDOC ## GET /api/user ### Description Retrieve the current API user details. ### Method GET ### Endpoint /api/user ``` -------------------------------- ### GET /api/people/{person_id}/positions/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/delete_api_people__person_id__assis__id_ Retrieves a position. ```APIDOC ## GET /api/people/{person_id}/positions/{id} ### Description Retrieves a position. ### Method GET ### Endpoint /api/people/{person_id}/positions/{id} ### Parameters #### Path Parameters - **person_id** - Required - The ID of the person. - **id** - Required - The ID of the position. ``` -------------------------------- ### GET /api/protocols/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/CalEventAttendee/delete_api_cal_events__cal_event_id__cal_event_attendees__id_ Retrieves a specific protocol by ID. ```APIDOC ## GET /api/protocols/{id} ### Description Retrieves a specific protocol by ID. ### Method GET ### Endpoint /api/protocols/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the protocol. ``` -------------------------------- ### GET /api/check_connection Source: https://api.centralstationcrm.net/api-docs/index.html#/Person Retrieves the connection status of the API key. ```APIDOC ## GET /api/check_connection ### Description Retrieves the connection status of the API key. ### Method GET ### Endpoint /api/check_connection ``` -------------------------------- ### GET /api/group_calendars Source: https://api.centralstationcrm.net/api-docs/index.html#/GroupCalendar Retrieves all group calendars. ```APIDOC ## GET /api/group_calendars ### Description Retrieves all group calendars. ### Method GET ### Endpoint /api/group_calendars ``` -------------------------------- ### POST /api/hooks Source: https://api.centralstationcrm.net/api-docs/index.html#/Hook/post_api_hooks Creates a hook. ```APIDOC ## POST /api/hooks ### Description Creates a hook. ### Method POST ### Endpoint /api/hooks ``` -------------------------------- ### GET /api/people/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Person Retrieves a person. ```APIDOC ## GET /api/people/{id} ### Description Retrieves a person. ### Method GET ### Endpoint /api/people/{id} ``` -------------------------------- ### POST /api/deals/{deal_id}/protocols/{protocol_id}/attachments Source: https://api.centralstationcrm.net/api-docs/index.html#/Attachment/get_api_attachments_search Creates an attachment for a specific deal protocol. ```APIDOC ## POST /api/deals/{deal_id}/protocols/{protocol_id}/attachments ### Description Creates an attachment for a specific deal protocol. ### Method POST ### Endpoint /api/deals/{deal_id}/protocols/{protocol_id}/attachments ### Parameters #### Path Parameters - **deal_id** (string) - Required - The deal ID. - **protocol_id** (string) - Required - The protocol ID. ``` -------------------------------- ### GET /api/historic_events Source: https://api.centralstationcrm.net/api-docs/index.html#/Hook/post_api_hooks Retrieves all historic_events of the account. ```APIDOC ## GET /api/historic_events ### Description Retrieves all historic_events of the account. ### Method GET ### Endpoint /api/historic_events ``` -------------------------------- ### POST /api/attachments/ Source: https://api.centralstationcrm.net/api-docs/index.html#/Attachment/get_api_attachments_search Creates an attachment. ```APIDOC ## POST /api/attachments/ ### Description Creates an attachment. ### Method POST ### Endpoint /api/attachments/ ``` -------------------------------- ### GET /api/people/{person_id}/addrs/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Person Retrieves the addr. ```APIDOC ## GET /api/people/{person_id}/addrs/{id} ### Description Retrieves the addr. ### Method GET ### Endpoint /api/people/{person_id}/addrs/{id} ``` -------------------------------- ### GET /api/companies/{company_id}/protocols/{protocol_id}/attachments Source: https://api.centralstationcrm.net/api-docs/index.html#/Company-nested/put_api_companies__company_id__addrs__id_ Retrieves all attachments. ```APIDOC ## GET /api/companies/{company_id}/protocols/{protocol_id}/attachments ### Description Retrieves all attachments. ### Method GET ### Endpoint /api/companies/{company_id}/protocols/{protocol_id}/attachments ### Parameters #### Path Parameters - **company_id** (string) - Required - The ID of the company. - **protocol_id** (string) - Required - The ID of the protocol. ``` -------------------------------- ### GET /api/protocols/{protocol_id}/attachments Source: https://api.centralstationcrm.net/api-docs/index.html#/Attachment/get_api_people__person_id__protocols__protocol_id__attachments_search Retrieves all attachments for a protocol. ```APIDOC ## GET /api/protocols/{protocol_id}/attachments ### Description Retrieves all attachments for a protocol. ### Method GET ### Endpoint /api/protocols/{protocol_id}/attachments ### Parameters #### Path Parameters - **protocol_id** (integer) - Required - The ID of the protocol. ### Response #### Success Response (200) (No response example provided) ``` -------------------------------- ### GET /api/people Source: https://api.centralstationcrm.net/api-docs/index.html#/Person/get_api_people__id_ Retrieves all people. This endpoint returns a list of all person records. ```APIDOC ## [GET] /api/people ### Description Retrieves all people. ### Method GET ### Endpoint /api/people ### Response #### Success Response (200) - **person** (object) - The person object #### Response Example { "person": { "user_id": 0, "group_id": 0, "country_code": "de", "salutation": "Mr. Nice-Guy", "title": "Dr.", "gender_identity": "male", "first_name": "Jolly", "name": "Mäh", "background": "2 kids, hobby cyclist", "id": 0, "account_id": 0, "created_by_user_id": 0, "updated_by_user_id": 0, "created_at": "2026-10-23T13:04:11.038Z", "updated_at": "2026-10-23T13:04:11.038Z" } } ``` -------------------------------- ### GET /api/custom_fields_types Source: https://api.centralstationcrm.net/api-docs/index.html#/ContactDetails/delete_api_companies__company_id__contact_details__id_ Retrieves all CustomFieldTypes of the account. ```APIDOC ## GET /api/custom_fields_types ### Description Retrieves all CustomFieldTypes of the account. ### Method GET ### Endpoint /api/custom_fields_types ``` -------------------------------- ### GET /api/companies/{company_id}/contact_details Source: https://api.centralstationcrm.net/api-docs/index.html#/Company-nested/put_api_companies__company_id__addrs__id_ Retrieves all contact_details of the company. ```APIDOC ## GET /api/companies/{company_id}/contact_details ### Description Retrieves all contact_details of the company. ### Method GET ### Endpoint /api/companies/{company_id}/contact_details ### Parameters #### Path Parameters - **company_id** (string) - Required - The ID of the company. ``` -------------------------------- ### POST /api/people Source: https://api.centralstationcrm.net/api-docs/index.html#/Person Creates a person. ```APIDOC ## POST /api/people ### Description Creates a person. ### Method POST ### Endpoint /api/people ``` -------------------------------- ### GET /api/people/{person_id}/positions Source: https://api.centralstationcrm.net/api-docs/index.html#/Hook/post_api_hooks Retrieves all positions for a person. ```APIDOC ## GET /api/people/{person_id}/positions ### Description Retrieves all positions. ### Method GET ### Endpoint /api/people/{person_id}/positions ### Parameters #### Path Parameters - **person_id** (string) - Required - The ID of the person whose positions to retrieve. ``` -------------------------------- ### GET /api/people/{person_id}/addrs Source: https://api.centralstationcrm.net/api-docs/index.html#/Person Retrieves all addrs of the person. ```APIDOC ## GET /api/people/{person_id}/addrs ### Description Retrieves all addrs of the person. ### Method GET ### Endpoint /api/people/{person_id}/addrs ``` -------------------------------- ### GET /api/people/{person_id}/positions Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/post_api_people__person_id__positions Retrieves all positions for a person. ```APIDOC ## GET /api/people/{person_id}/positions ### Description Retrieves all positions for a person. ### Method GET ### Endpoint /api/people/{person_id}/positions ### Parameters #### Path Parameters - **person_id** (integer) - Required - The ID of the person. ``` -------------------------------- ### GET /api/companies/search Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/delete_api_people__person_id__tags__id_ Retrieves companies matching the search criteria. ```APIDOC ## GET /api/companies/search ### Description Retrieves companies matching the search. ### Method GET ### Endpoint /api/companies/search ``` -------------------------------- ### GET /api/companies/search Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/post_api_people__person_id__positions Retrieves companies matching the search criteria. ```APIDOC ## GET /api/companies/search ### Description Retrieves companies matching the search criteria. ### Method GET ### Endpoint /api/companies/search ``` -------------------------------- ### DELETE /api/projects/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Deal-nested/post_api_deals__deal_id__protocols__protocol_id__attachments Destroys a project. ```APIDOC ## DELETE /api/projects/{id} ### Description Destroys a project. ### Method DELETE ### Endpoint /api/projects/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the project. ``` -------------------------------- ### GET /api/companies/{company_id}/addrs Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/delete_api_people__person_id__tags__id_ Retrieves all addresses for a company. ```APIDOC ## GET /api/companies/{company_id}/addrs ### Description Retrieves all addrs of the company. ### Method GET ### Endpoint /api/companies/{company_id}/addrs ### Parameters #### Path Parameters - **company_id** (string) - Required - The ID of the company. ``` -------------------------------- ### POST /api/protocols Source: https://api.centralstationcrm.net/api-docs/index.html#/Protocol/delete_api_protocols__id_ Creates a new protocol. This endpoint allows you to add a new protocol to the system. ```APIDOC ## POST /api/protocols ### Description Creates a protocol. ### Method POST ### Endpoint /api/protocols ### Request Body - **subject** (string) - Required - The subject of the protocol - **body** (text) - Required - The content of the protocol ### Request Example ```json { "subject": "Meeting notes", "body": "Discussed project timeline" } ``` ### Response #### Success Response (201) - **id** (integer) - The ID of the created protocol - **subject** (string) - The subject of the protocol - **body** (text) - The content of the protocol #### Response Example ```json { "id": 1, "subject": "Meeting notes", "body": "Discussed project timeline" } ``` ``` -------------------------------- ### POST /api/deals/{deal_id}/protocols/{protocol_id}/attachments Source: https://api.centralstationcrm.net/api-docs/index.html#/Company-nested/post_api_companies__company_id__contact_details Creates an attachment for a specific protocol of a deal. ```APIDOC ## POST /api/deals/{deal_id}/protocols/{protocol_id}/attachments ### Description Creates an attachment for a specific protocol of a deal. ### Method POST ### Endpoint /api/deals/{deal_id}/protocols/{protocol_id}/attachments ### Parameters #### Path Parameters - **deal_id** (integer) - Required - The ID of the deal. - **protocol_id** (integer) - Required - The ID of the protocol. ``` -------------------------------- ### GET /api/comments/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Tag/get_api_people__person_id__tags Retrieves a specific comment. ```APIDOC ## GET /api/comments/{id} ### Description Retrieves a specific comment. ### Method GET ### Endpoint /api/comments/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the comment. ``` -------------------------------- ### GET /api/deals/{deal_id}/protocols/{protocol_id}/attachments Source: https://api.centralstationcrm.net/api-docs/index.html#/Attachment/get_api_attachments_search Retrieves all attachments for a specific deal protocol. ```APIDOC ## GET /api/deals/{deal_id}/protocols/{protocol_id}/attachments ### Description Retrieves all attachments for a specific deal protocol. ### Method GET ### Endpoint /api/deals/{deal_id}/protocols/{protocol_id}/attachments ### Parameters #### Path Parameters - **deal_id** (string) - Required - The deal ID. - **protocol_id** (string) - Required - The protocol ID. ``` -------------------------------- ### GET /api/users/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Tag/get_api_people__person_id__tags Retrieves a specific user. ```APIDOC ## GET /api/users/{id} ### Description Retrieves a specific user. ### Method GET ### Endpoint /api/users/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the user. ``` -------------------------------- ### POST /api/people/{person_id}/positions Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/post_api_people__person_id__positions Creates a basic position for a person. ```APIDOC ## POST /api/people/{person_id}/positions ### Description Creates a basic position for a person. ### Method POST ### Endpoint /api/people/{person_id}/positions ### Parameters #### Path Parameters - **person_id** (integer) - Required - The ID of the person. ``` -------------------------------- ### GET /api/tasks/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Tag/get_api_people__person_id__tags Retrieves a specific task. ```APIDOC ## GET /api/tasks/{id} ### Description Retrieves a specific task. ### Method GET ### Endpoint /api/tasks/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the task. ``` -------------------------------- ### GET /api/avatars/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Attachment/get_api_people__person_id__protocols__protocol_id__attachments_search Retrieves a specific avatar. ```APIDOC ## GET /api/avatars/{id} ### Description Retrieves a specific avatar. ### Method GET ### Endpoint /api/avatars/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the avatar. ### Response #### Success Response (200) (No response example provided) ``` -------------------------------- ### POST /api/people/{person_id}/positions Source: https://api.centralstationcrm.net/api-docs/index.html#/Hook/post_api_hooks Creates a basic position for a person. ```APIDOC ## POST /api/people/{person_id}/positions ### Description Creates a basic position. ### Method POST ### Endpoint /api/people/{person_id}/positions ### Parameters #### Path Parameters - **person_id** (string) - Required - The ID of the person for whom to create the position. ``` -------------------------------- ### GET /api/filter_groups Source: https://api.centralstationcrm.net/api-docs/index.html#/ExternalEmail-nested/get_api_external_emails__external_email_id__attachments Retrieves all filter groups of the account. ```APIDOC ## GET /api/filter_groups ### Description Retrieves all filter groups associated with the account. ### Method GET ### Endpoint /api/filter_groups ### Response #### Success Response (200) - Returns a list of filter groups. #### Response Example ```json [ { "id": 1, "name": "My Filter" } ] ``` ``` -------------------------------- ### POST /api/companies/{company_id}/protocols/{protocol_id}/attachments Source: https://api.centralstationcrm.net/api-docs/index.html#/CalEventAttendee/delete_api_cal_events__cal_event_id__cal_event_attendees__id_ Creates an attachment for a protocol under a company. ```APIDOC ## POST /api/companies/{company_id}/protocols/{protocol_id}/attachments ### Description Creates an attachment for a protocol under a company. ### Method POST ### Endpoint /api/companies/{company_id}/protocols/{protocol_id}/attachments ### Parameters #### Path Parameters - **company_id** (integer) - Required - The ID of the company. - **protocol_id** (integer) - Required - The ID of the protocol. ``` -------------------------------- ### POST /api/companies/{company_id}/protocols/{protocol_id}/attachments Source: https://api.centralstationcrm.net/api-docs/index.html#/Company-nested/put_api_companies__company_id__addrs__id_ create attachment. ```APIDOC ## POST /api/companies/{company_id}/protocols/{protocol_id}/attachments ### Description create attachment. ### Method POST ### Endpoint /api/companies/{company_id}/protocols/{protocol_id}/attachments ### Parameters #### Path Parameters - **company_id** (string) - Required - The ID of the company. - **protocol_id** (string) - Required - The ID of the protocol. ``` -------------------------------- ### GET /api/avatars/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Attachment/get_api_people__person_id__protocols__protocol_id__attachments__id_ Retrieves a specific avatar. ```APIDOC ## GET /api/avatars/{id} ### Description Retrieves a specific avatar. ### Method GET ### Endpoint /api/avatars/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the avatar. ``` -------------------------------- ### GET /api/people/{person_id}/protocols/{protocol_id}/attachments/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/delete_api_people__person_id__assis__id_ Retrieves an attachment. ```APIDOC ## GET /api/people/{person_id}/protocols/{protocol_id}/attachments/{id} ### Description Retrieves an attachment. ### Method GET ### Endpoint /api/people/{person_id}/protocols/{protocol_id}/attachments/{id} ### Parameters #### Path Parameters - **person_id** - Required - The ID of the person. - **protocol_id** - Required - The ID of the protocol. - **id** - Required - The ID of the attachment. ``` -------------------------------- ### POST /api/attachments/ Source: https://api.centralstationcrm.net/api-docs/index.html#/Addr/put_api_companies__company_id__addrs__id_ Creates an attachment. ```APIDOC ## POST /api/attachments/ ### Description create attachment. ### Method POST ### Endpoint /api/attachments/ ``` -------------------------------- ### GET /api/companies/{company_id}/protocols/{protocol_id}/attachments/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Company-nested/put_api_companies__company_id__addrs__id_ retrieve attachment. ```APIDOC ## GET /api/companies/{company_id}/protocols/{protocol_id}/attachments/{id} ### Description retrieve attachment. ### Method GET ### Endpoint /api/companies/{company_id}/protocols/{protocol_id}/attachments/{id} ### Parameters #### Path Parameters - **company_id** (string) - Required - The ID of the company. - **protocol_id** (string) - Required - The ID of the protocol. - **id** (string) - Required - The ID of the attachment. ``` -------------------------------- ### POST /api/companies/{company_id}/addrs Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/delete_api_people__person_id__tags__id_ Creates a basic address for a company. ```APIDOC ## POST /api/companies/{company_id}/addrs ### Description Creates a basic Addr. ### Method POST ### Endpoint /api/companies/{company_id}/addrs ### Parameters #### Path Parameters - **company_id** (string) - Required - The ID of the company. ``` -------------------------------- ### POST /api/projects/{project_id}/protocols/{protocol_id}/attachments Source: https://api.centralstationcrm.net/api-docs/index.html#/Attachment/get_api_people__person_id__protocols__protocol_id__attachments_search Creates a new attachment for a specific protocol of a project. ```APIDOC ## POST /api/projects/{project_id}/protocols/{protocol_id}/attachments ### Description Creates a new attachment for a specific protocol of a project. ### Method POST ### Endpoint /api/projects/{project_id}/protocols/{protocol_id}/attachments ### Parameters #### Path Parameters - **project_id** (integer) - Required - The ID of the project. - **protocol_id** (integer) - Required - The ID of the protocol. ### Request Example (No request body example provided) ### Response #### Success Response (200) (No response example provided) ``` -------------------------------- ### GET /api/people/{person_id}/avatars Source: https://api.centralstationcrm.net/api-docs/index.html#/Person Retrieves all avatars. ```APIDOC ## GET /api/people/{person_id}/avatars ### Description Retrieves all avatars. ### Method GET ### Endpoint /api/people/{person_id}/avatars ``` -------------------------------- ### POST /api/comments Source: https://api.centralstationcrm.net/api-docs/index.html#/Tag/get_api_people__person_id__tags Creates a comment. ```APIDOC ## POST /api/comments ### Description Creates a comment. ### Method POST ### Endpoint /api/comments ``` -------------------------------- ### GET /api/people/count Source: https://api.centralstationcrm.net/api-docs/index.html#/Person Retrieves total amount of people. ```APIDOC ## GET /api/people/count ### Description Retrieves total amount of people. ### Method GET ### Endpoint /api/people/count ``` -------------------------------- ### GET /api/people/search Source: https://api.centralstationcrm.net/api-docs/index.html#/Person Retrieves people matching the search. ```APIDOC ## GET /api/people/search ### Description Retrieves people matching the search. ### Method GET ### Endpoint /api/people/search ``` -------------------------------- ### GET /api/companies/stats Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/delete_api_people__person_id__tags__id_ Retrieves key information about companies. ```APIDOC ## GET /api/companies/stats ### Description Retrieves key information of companies. ### Method GET ### Endpoint /api/companies/stats ``` -------------------------------- ### POST /api/companies/{company_id}/contact_details Source: https://api.centralstationcrm.net/api-docs/index.html#/ContactDetails/delete_api_companies__company_id__contact_details__id_ Creates a basic tel for a company. ```APIDOC ## POST /api/companies/{company_id}/contact_details ### Description Creates a basic tel for a company. ### Method POST ### Endpoint /api/companies/{company_id}/contact_details ### Parameters #### Path Parameters - **company_id** (string) - Required - The ID of the company. ``` -------------------------------- ### GET /api/companies/count Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/delete_api_people__person_id__tags__id_ Retrieves the total number of companies. ```APIDOC ## GET /api/companies/count ### Description Retrieves total amount of companies. ### Method GET ### Endpoint /api/companies/count ``` -------------------------------- ### GET /api/deals/{deal_id}/protocols/{protocol_id}/attachments/search Source: https://api.centralstationcrm.net/api-docs/index.html#/Attachment/get_api_attachments_search Retrieves attachments matching the search for a specific deal protocol. ```APIDOC ## GET /api/deals/{deal_id}/protocols/{protocol_id}/attachments/search ### Description Retrieves attachments matching the search for a specific deal protocol. ### Method GET ### Endpoint /api/deals/{deal_id}/protocols/{protocol_id}/attachments/search ### Parameters #### Path Parameters - **deal_id** (string) - Required - The deal ID. - **protocol_id** (string) - Required - The protocol ID. ``` -------------------------------- ### GET /api/cal_events/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/CalEvent/put_api_cal_events__id_ Retrieves a cal event. ```APIDOC ## GET /api/cal_events/{id} ### Description Retrieves a cal event. ### Method GET ### Endpoint /api/cal_events/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the cal event. ``` -------------------------------- ### GET /api/cal_events Source: https://api.centralstationcrm.net/api-docs/index.html#/CalEvent/put_api_cal_events__id_ Retrieves all cal events of the account. ```APIDOC ## GET /api/cal_events ### Description Retrieves all cal events of the account. ### Method GET ### Endpoint /api/cal_events ``` -------------------------------- ### GET /api/companies/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/delete_api_people__person_id__tags__id_ Retrieves a specific company. ```APIDOC ## GET /api/companies/{id} ### Description Retrieves a company. ### Method GET ### Endpoint /api/companies/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the company. ``` -------------------------------- ### POST /api/people/{person_id}/contact_details Source: https://api.centralstationcrm.net/api-docs/index.html#/ContactDetails/delete_api_companies__company_id__contact_details__id_ Creates a basic tel for a person. ```APIDOC ## POST /api/people/{person_id}/contact_details ### Description Creates a basic tel for a person. ### Method POST ### Endpoint /api/people/{person_id}/contact_details ### Parameters #### Path Parameters - **person_id** (string) - Required - The ID of the person. ``` -------------------------------- ### GET /api/deals/{deal_id}/protocols/{protocol_id}/attachments/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Attachment/get_api_attachments_search Retrieves a specific attachment for a deal protocol. ```APIDOC ## GET /api/deals/{deal_id}/protocols/{protocol_id}/attachments/{id} ### Description Retrieves a specific attachment for a deal protocol. ### Method GET ### Endpoint /api/deals/{deal_id}/protocols/{protocol_id}/attachments/{id} ### Parameters #### Path Parameters - **deal_id** (string) - Required - The deal ID. - **protocol_id** (string) - Required - The protocol ID. - **id** (string) - Required - The attachment ID. ``` -------------------------------- ### GET /api/companies/stats Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/post_api_people__person_id__positions Retrieves key information about companies. ```APIDOC ## GET /api/companies/stats ### Description Retrieves key information about companies. ### Method GET ### Endpoint /api/companies/stats ``` -------------------------------- ### POST /api/people/{person_id}/contact_details Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/get_api_people__person_id__avatars__id_ Creates a basic tel contact detail for the person. ```APIDOC ## POST /api/people/{person_id}/contact_details ### Description Creates a basic tel contact detail for the person. ### Method POST ### Endpoint /api/people/{person_id}/contact_details ### Parameters #### Path Parameters - **person_id** (string) - Required - The ID of the person. ### Response #### Success Response (200) - **contact_detail** (object) - The created contact detail. #### Error Responses - **401** - Not authorized - **404** - Not found - **500** - Internal error ``` -------------------------------- ### GET /api/companies/count Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/post_api_people__person_id__positions Retrieves the total number of companies. ```APIDOC ## GET /api/companies/count ### Description Retrieves the total number of companies. ### Method GET ### Endpoint /api/companies/count ``` -------------------------------- ### GET /api/companies/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Person-nested/post_api_people__person_id__positions Retrieves a specific company. ```APIDOC ## GET /api/companies/{id} ### Description Retrieves a specific company. ### Method GET ### Endpoint /api/companies/{id} ### Parameters #### Path Parameters - **id** (integer) - Required - The ID of the company. ``` -------------------------------- ### POST /api/people/{person_id}/avatars Source: https://api.centralstationcrm.net/api-docs/index.html#/Person Create avatar. ```APIDOC ## POST /api/people/{person_id}/avatars ### Description Create avatar. ### Method POST ### Endpoint /api/people/{person_id}/avatars ``` -------------------------------- ### GET /api/hooks/{id} Source: https://api.centralstationcrm.net/api-docs/index.html#/Hook/post_api_hooks Retrieves a hook by its ID. ```APIDOC ## GET /api/hooks/{id} ### Description Retrieves a hook. ### Method GET ### Endpoint /api/hooks/{id} ### Parameters #### Path Parameters - **id** (string) - Required - The ID of the hook to retrieve. ``` -------------------------------- ### POST /api/people/{person_id}/assis Source: https://api.centralstationcrm.net/api-docs/index.html#/ExternalEmail-nested/get_api_external_emails__external_email_id__attachments Creates an assi for the person. ```APIDOC ## POST /api/people/{person_id}/assis ### Description Creates a new assi for the specified person. ### Method POST ### Endpoint /api/people/{person_id}/assis ### Parameters #### Path Parameters - **person_id** (integer) - Required - The ID of the person. #### Request Body - **name** (string) - Required - The name of the assi. ### Response #### Success Response (201) - Returns the created assi. #### Response Example ```json { "id": 1, "name": "Assi" } ``` ```