/v4/users/query
(Last updated: 16/05/2023)
Request
Method
POST
URL
https://api.medipim.be/v4/users/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 users by Medipim ID. | One or more IDs | {"id": 1} or {"id": [1, 2]} |
{"organization": ...} |
Matches user by it's organization. | Medipim organization ID | {"organization": 1} |
{"vatNr": ...} |
Matches users by the VAT number of linked organization. | String | {"vatNr": "BE0123321123"} |
{"apbNr": ...} |
Matches users by the APB number of linked organization. | String | {"apbNr": 123456} |
{"rizivNr": ...} |
Matches users by the Riziv number of linked organization. | String | {"rizivNr": ...} |
{"and": [...]} |
Matches users that match all of the given filters. | A list of filters. | {"and": [{"id": 1}, {"organization": 1}]} |
{"or": [...]} |
Matches users that match any of the given filters. | A list of filters. | {"or": [{"id": 1}, {"id": 2}]} |
{"not": ...} |
Matches users that do not match the given filter. | A filter. | {"not": {"organization": 1}} |
| Sorting | Description | Parameters | Examples |
|---|---|---|---|
{"id": ...} |
Sort by Medipim ID | "ASC" or "DESC" |
{"id": "ASC"} or {"id": "DESC"} |
Response
Body
metatotal: total number of users (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 user (integer)name: Name of the user (string)organization: Medipim ID of the user organization (integer)
Notice
The meta page section will only be returned if you added a page in the request body.