Skip to main content

Search

api_get_contact_json

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_json",
  "format": "json",
  "arguments": {
    "ids": "1,2,3,4"
  }
}
Field Type Required Description
function string Yes The name of the API function. Use "api_get_contact_json" for this request
format string Yes The response format - json
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

Format - JSON

Example Response

[{
                                        "isarchive": null,
                                        "company_id": 87458,
                                        "contact_id": 196879,
                                        "contact_name": "Приймачук Валентина Анатоліївна ",
                                        "contact_spec": "Гастроентерологія",
                                        "contact_type": "All",
                                        "contact_categ": null,
                                        "contact_email": null,
                                        "contact_phone": " 0963289903",
                                        "contact_target": [
                                            "Rx-Гастроентеролог"
                                        ],
                                        "company_morionid": 3475149,
                                        "contact_morionid": null,
                                        "contact_categ_by_direction": ["RX-A","OTC-B"]
                                    }
                                ]
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)