POST /v4/organizations/query
(Last updated: 24/01/2025)
Request
Method
POST
URL
https://api.medipim.fr/v4/organizations/query
Headers
Body
filter
: one of the filters below; filters can be combined usingand
,or
¬
. (optional)sorting
: one of the sortings below. (optional; default is{"id": "ASC"}
)-
page
(optional; if none is provided all results are returned)no
: page number (zero-based)size
: one of 10, 50, 100 or 250 (defaults to 100)
Filter | Description | Parameters | Examples |
---|---|---|---|
{"id": ...} |
Matches organizations by Medipim ID. | One or more IDs | {"id": 1} or {"id": [1, 2]} |
{"type": ...} |
Matches organizations by type. | type : Type of organization (
"supplier" , "marketing" , "medical_professional" , "other" ) |
{"type": "supplier"} |
{"name": ...} |
Matches organizations by name. | String | {"name": "Medipim"} |
{"searchName": ...} |
Matches organizations by searching their name. | String | {"searchName": "Pharma"} |
{"specializations": ...} |
Matches organizations by their specializations. | One or more Medipim public category IDs | {"specializations": 1} or {"specializations": [1, 2]} |
{"vatNr": ...} |
Matches organizations by the VAT number. | String | {"vatNr": "BE0123321123"} |
{"finessNr": ...} |
Matches organizations by the Finess number | String | {"finessNr": "A12345678"} |
{"cipNr": ...} |
Matches organizations by the CIP-GERS number. | Integer or String | {"cipNr": "1000123"} |
{"and": [...]} |
Matches organizations that match all of the given filters. | A list of filters. | {"and": [{"searchName": "Pharma"}, {"type": "supplier"}]} |
{"or": [...]} |
Matches organizations that match any of the given filters. | A list of filters. | {"or": [{"type": "supplier"}, {"type": "medical_professional"}]} |
{"not": ...} |
Matches organizations that do not match the given filter. | A filter. | {"not": {"type": "supplier"}} |
Sorting | Description | Parameters | Examples |
---|---|---|---|
{"id": ...} |
Sort by Medipim ID | "ASC" or "DESC" |
{"id": "ASC"} or {"id": "DESC"} |
{"name": ...} |
Sort by name | "ASC" or "DESC" |
{"name": "ASC"} or {"name": "DESC"} |
Response
Body
-
meta
total
: total number of organizations (integer)-
page
:no
: page number (zero-based) (integer)offset
: offset of the first item in the entire resultset (integer)size
: size of the page (integer)
-
results[]
id
: Medipim ID of the organization (integer, unique)name
: Name of the organization (string)type
: Type of organization ("supplier"
,"marketing"
,"medical_professional"
,"other"
)brands[]
: List of associated Medipim brand IDs (integer[])productFamilies[]
: List of associated Medipim product family IDs (integer[])-
meta
:createdAt
: When the organization was created on Medipim (unix timestamp)updatedAt
: when the organization information was last updated (unix timestamp)
-
contactInformation
: Only available when the organisation type equals supplier.address
: Street address of the organization (string, optional)zipCode
: Zip code of the city (string, optional)city
: Name of the city (string, optional)country
: ISO2 code of the country where the organization is located (string, optional)url
: Url of organization website (string, optional)
Notice
The meta page section will only be returned if you added a page in the request body.