| Authentication (Login) |
Authenticates the user and returns a token for authorizing API requests |
| Data Generation Request |
Triggers a data generation task. The request supports optional parameters and allows results in either JSON or CSV format. The system processes the request asynchronously and returns a job ID for tracking. |
| Get Data Generation Job Status |
Checks the current status of a previously submitted data generation job. It returns the status code and additional information about the job, such as batch count (for JSON responses) |
| Get Data Generation Job Result |
Retrieves the result of a previously completed data generation job. The format of the response depends on the format specified when the job was initially requested (csv or json). |
| api_get_users |
Retrieves a list of all users from the Proxima CRM system. You can optionally filter the list by specific user IDs. |
| api_get_company |
Returns a list of institutions (companies) that have been visited at least once. There is no time period limitation on the visit history. |
| api_get_contact |
Returns a list of clients (contacts) who have been visited at least once, with no time period restriction. |
| api_get_tasks |
Retrieves information about visit activity within a specified time range. The API supports optional filtering by task IDs and user ID. |
| api_get_actions |
Retrieves information about non-visit activities (tasks) performed during a specified time range. The API supports optional filtering by task IDs and user ID. |
| api_get_entitymap |
Retrieves information about the mapping between the field names visible to the user in the “Arrangement” and “Control” cards and the system columns, segmented by user roles. |
| api_get_pdk |
Retrieves the information entered during a visit in the “Control” card. The set of completed parameters depends on the client’s specific configuration. Use api_get_entitymap to get the configuration. |
| api_get_arrangement |
Retrieves the information entered during a visit in the “Arrangement” card. The set of completed parameters depends on the client’s specific configuration. Use api_get_entitymap to get the configuration. |
| api_get_preparation |
Retrieves the information about brands and drugs uploaded to the system. |
| api_get_arrangement_json |
Retrieves the information entered during a visit in the “Arrangement” card. The set of completed parameters depends on the client’s specific configuration. |
| api_get_pdk_json |
Retrieves the information entered during a visit in the “Control” card. The set of completed parameters depends on the client’s specific configuration. |
| api_get_tasks_json |
Retrieves information about visit activity within a specified time range. The API supports optional filtering by task IDs and user ID. |
| api_get_actions_json |
Retrieves information about non-visit activities (tasks) performed during a specified time range. The API supports optional filtering by task IDs and user ID. |
| api_get_users_json |
Retrieves a list of all users from the Proxima CRM system. You can optionally filter the list by specific user IDs. |
| api_get_entitymap_json |
Retrieves information about the mapping between the field names visible to the user in the “Arrangement” and “Control” cards and the system columns, segmented by user roles. |
| api_get_company_json |
Returns a list of institutions (companies) that have been visited at least once. There is no time period limitation on the visit history. |
| api_get_contact_json |
Returns a list of clients (contacts) who have been visited at least once, with no time period restriction. |
| api_get_preparation_json |
Retrieves the information about brands and drugs uploaded to the system. |