/v4/organizations/query
(Last updated: 16/05/2023)
Request
Method
POST
URL
https://api.medipim.be/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. | Possible values: "supplier", "marketing","medical_professional" or "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"} |
{"apbNr": ...} |
Matches organizations by the APB number. | Integer or String | {"apbNr": 123456} |
{"rizivNr": ...} |
Matches organizations by the Riziv number. | String | {"rizivNr": ...} |
{"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
metatotal: total number of organizations (integer)pageno: 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)name: Name of the organization (string)type: Type of the organization ("supplier","marketing","medical_professional"or"other")brands[]: List of associated Medipim brand IDs (integer[])telephone: Phone number of the organization (string)meta:createdAt: When the organization was created on Medipim (unix timestamp)updatedAt: when the organization information was last updated (unix timestamp)
Notice
The meta page section will only be returned if you added a page in the request body.