Returns a list of clients (contacts) who have been visited at least once, with no time period restriction.
Request
Endpoint
POST https://yourdomain.pharmahrm.com/crm-api/db-function/run
Authentication
Bearer Token (required)
Request Structure
Headers
| Key | Value |
|---|---|
| Authorization | Bearer <token>
|
| Content-Type | application/json |
Request Body
{
"function": "api_get_contact",
"format": "csv",
"arguments": {
"ids": "1,2,3,4"
}
}| Field | Type | Required | Description |
|---|---|---|---|
| function | string | Yes | The name of the API function. Use "api_get_contact" for this request |
| format | string | Yes | The response format - csv |
| arguments | object | Optional | Object containing additional arguments |
| ids | string | Optional | A comma-separated list of client IDs (from Proxima CRM DB). Filters output. If omitted, all visited clients will be returned |
Successful Response
200 OK
When format is set to "csv", the response will be returned as plain text CSV.
Content-Type
text/plain
Example Response
contact_name,contact_type,contact_spec,contact_target,contact_categ,contact_categ_by_direction,isarchive,contact_morionid,company_id,company_morionid,contact_email,contact_phone,contact_id
Dr. John Smith,Doctor,Cardiologist,A,VIP,A,No,AXC12345,110,AMX99322,j.smith@example.com,+380501234567,555
| Field | Description |
|---|---|
| contact_name | Full name of the client |
| contact_type | Client type (e.g., Doctor, Pharmacist) |
| contact_spec | Client's specialization (e.g., Cardiologist) |
| contact_target | Target group/category the client belongs to |
| contact_categ | General client category |
| contact_categ_by_direction | Client category by product direction |
| isarchive | Archive flag — contains reason if archived |
| contact_morionid | Client identifier in the Axioma database |
| conpamy_id | Institution ID from Proxima CRM (main place of work) |
| company_morionid | Institution ID from Axioma DB (main place of work) |
| contact_email | Client’s email address |
| contact_phone | Client’s phone number |
| contact_id | Unique identifier of the client in Proxima CRM |
Error Responses
40x/50x
{
"message": "string"
}| Code Range | Description |
|---|---|
| 400 - 499 | Client-side error (e.g., malformed request, missing auth) |
| 500–599 | Server-side error (e.g., internal processing issues) |