Skip to main content

Search

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.

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_company_json",
  "format": "json",
  "arguments": {
    "ids": "1,2,3,4"
  }
}
Field Type Required Description
function string Yes The name of the method to call. Use "api_get_company_json" for this request
format string Yes The response format - json
arguments object Optional Optional arguments specific to the method
ids string Optional A comma-separated list of company IDs from the Proxima CRM database. Only companies with matching IDs will be returned. If omitted, all visited companies will be returned

Successful Response

Format: JSON

Example Response

[{
        "isarchive": null,
        "company_id": 74212,
        "company_city": "Бердичів",
        "company_code": null,
        "company_main": "Лікарня міська",
        "company_name": "Поліклініка Лікарні
міської", "company_type": "Амбулаторно-поліклінічні заклади", "company_categ": null, "company_phone": "Стаціон.
(робочий): 0414325121,
        0414342898,
        0414322228,
        0414326419,
        0414327010, Стаціон. (реєстратура): 0414341001,
        0414321181,
Стаціон. (відділ кадрів): 0414325118,
        0414342349", "company_center": null, "company_isshop": 0, "company_region":"Житомирська",
        "company_address": "Житомирська 42",
        "company_country": "Україна",
        "company_gps_lat": "49.9032483",
        "company_gps_lng": "28.5853429",
        "company_morionid": 186144,
        "company_categ_by_direction": ["RX-A","OTC-B"]
    }]
Field Description
company_name Name of the institution
company_type Type of the institution (e.g., Pharmacy, Clinic)
company_address Institution address
company_categ General category of the institution
company_categ_by_direction Category by product line or direction
company_code Tax identification number of the legal entity
company_chain Name of the pharmacy/medical network (if applicable)
comapny_main Main or parent institution name
isarchive Archive flag — reason for archiving (if archived)
company_isshop Flag indicating if the location is a retail point (1 = yes)
company_morionid Institution identifier from the Axioma database
company_region Administrative region of the institution
company_city City of the institution
company_phone Contact phone number
company_gps_lat GPS latitude
company_gps_lng GPS longitude
company_id Internal Proxima CRM institution ID

Error Responses

40x/50x

{
  "message": "string"
}
Code Range Description
400-499 Client-side error (e.g., invalid token, bad request)
500-599 Server-side error (e.g., job execution failure)