The Client API from Nedap — 42 operation(s) for client.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/nedap-client-api"curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Nedap Client API
version: 0.0.0
description: 'Operations tagged Client across 2 of this provider''s published API definitions: nedap-ons-deprecated-openapi-original.json, nedap-ons-openapi-original.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api-development.ons.io
tags:
- name: Client
paths:
/t/clients:
post:
tags:
- Client
summary: Create Client
operationId: ClientAPI.create
parameters:
- name: X-Cupido-User-Name
in: header
schema:
type: string
- name: X-Cupido-Active-Identity
in: header
schema:
type: string
requestBody:
description: Client to create
content:
application/json:
schema:
$ref: '#/components/schemas/Client'
required: true
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/Client'
'400':
description: Validation or persistence problems
x-cupido-common-method: true
x-replaced-by: /v0/administration/clients
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/clients/{employee_id}/last_visited_clients:
get:
tags:
- Client
summary: Returns the last visited clients of an employee based on presence logs
operationId: ClientAPI.lastVisitedClients
parameters:
- name: employee_id
in: path
description: '- employee id'
required: true
schema:
type: integer
format: int64
- name: from_date
in: query
description: '- begin date of period'
required: true
schema:
type: string
format: date
- name: to_date
in: query
description: '- end date of period'
required: true
schema:
type: string
format: date
- name: offset
in: query
description: '- position in the result list to start from'
schema:
type: integer
format: int32
default: 0
- name: limit
in: query
description: '- limit of the result list'
schema:
type: integer
format: int32
default: 10
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.ClientList'
x-replaced-by: /v0/administration/clients/{employee_id}/last_visited_clients
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/clients/{id}:
get:
tags:
- Client
summary: Find a client by their primary key
operationId: ClientAPI.byId
parameters:
- name: id
in: path
description: used for selecting Client
required: true
schema:
type: integer
format: int64
- name: X-Cupido-User-Name
in: header
schema:
type: string
- name: X-Cupido-Active-Identity
in: header
schema:
type: string
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/Client'
'404':
description: Client not found
x-cupido-common-method: true
x-replaced-by: /v0/administration/clients/{id}
deprecated: true
x-deprecated-since: 19-11-2025
put:
tags:
- Client
summary: Update Client
operationId: ClientAPI.update
parameters:
- name: id
in: path
description: used for selecting Client
required: true
schema:
type: integer
format: int64
- name: X-Cupido-User-Name
in: header
schema:
type: string
- name: X-Cupido-Active-Identity
in: header
schema:
type: string
requestBody:
description: Client to update
content:
application/json:
schema:
$ref: '#/components/schemas/Client'
required: true
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/Client'
'400':
description: Validation or persistence problems, or identification number already exists
'404':
description: Client not found
x-cupido-common-method: true
x-replaced-by: /v0/administration/clients/{id}
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/clients/by_bsn:
get:
tags:
- Client
summary: Find a client by its BSN number
operationId: ClientAPI.byBSN
parameters:
- name: bsn
in: query
description: The bsn of the client to find
schema:
type: string
- name: X-Cupido-User-Name
in: header
schema:
type: string
- name: X-Cupido-Active-Identity
in: header
schema:
type: string
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/Client'
'404':
description: Client not found
'409':
description: If multiple clients are registered with the same BSN
x-replaced-by: /v0/administration/clients/by_bsn
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/clients/by_bsn/{bsn}:
get:
tags:
- Client
summary: Find a client by its BSN number
description: Use byBsn
operationId: ClientAPI.byBSNUnsafe
parameters:
- name: bsn
in: path
required: true
schema:
type: string
- name: X-Cupido-User-Name
in: header
schema:
type: string
- name: X-Cupido-Active-Identity
in: header
schema:
type: string
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/Client'
'404':
description: Client not found
'409':
description: If multiple clients are registered with the same BSN
deprecated: true
x-deprecated-since: 29-07-2020
x-replaced-by: /v0/administration/clients/by_bsn/{bsn}
servers:
- url: https://api-development.ons.io
/t/clients/by_skn:
get:
tags:
- Client
summary: Find a client by its SKN (strafrechtketennummer)
operationId: ClientAPI.bySkn
parameters:
- name: skn
in: query
description: the skn of the client to find.
schema:
type: string
- name: X-Cupido-User-Name
in: header
schema:
type: string
- name: X-Cupido-Active-Identity
in: header
schema:
type: string
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/Client'
'404':
description: Client not found
x-replaced-by: /v0/administration/clients/by_skn
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/clients/by_uuid/{uuid}:
get:
tags:
- Client
summary: Find a client by its UUID
operationId: ClientAPI.byUUID
parameters:
- name: uuid
in: path
required: true
schema:
type: string
format: uuid
- name: X-Cupido-User-Name
in: header
schema:
type: string
- name: X-Cupido-Active-Identity
in: header
schema:
type: string
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/Client'
'404':
description: Client not found
x-replaced-by: /v0/administration/clients/by_uuid/{uuid}
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/clients/by_identification_no/{identification_no}:
get:
tags:
- Client
summary: Find a client based on it's identification number, a logical identifier
operationId: ClientAPI.byIdentificationNo
parameters:
- name: identification_no
in: path
required: true
schema:
type: string
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/Client'
x-replaced-by: /v0/administration/clients/byIdentificationNumber/{identification_no}
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/clients/searchresult:
get:
tags:
- Client
summary: Results returned by this call are not grouped, i.e.
description: 'the {@link com.nedap.healthcare.domain.ClientSearchResult#group}
value is {@link com.nedap.healthcare.domain.ClientSearchResultGroup#UNGROUPED} for all results.'
operationId: ClientAPI.search
parameters:
- name: query
in: query
description: The string to search for
schema:
type: string
- name: employee_id
in: query
schema:
type: string
- name: limit
in: query
schema:
type: integer
format: int32
default: 10
- name: offset
in: query
schema:
type: integer
format: int32
default: 0
- name: include_waiting
in: query
schema:
type: boolean
- name: include_outofcare
in: query
schema:
type: boolean
- name: on_date
in: query
description: The search will be performed for the given date (instead of now)
schema:
type: string
format: date
- name: location_id
in: query
description: Limit the scope of search to within this location (only works when also using employee_id with an Employee that is linked to a User account)
schema:
type: integer
format: int64
- name: X-Cupido-User-Name
in: header
schema:
type: string
- name: X-Cupido-Active-Identity
in: header
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/list.ClientSearchResultList'
'404':
description: Employee not found
deprecated: true
x-deprecated-since: 01-03-2026
x-replaced-by: /v0/administration/clients/find
servers:
- url: https://api-development.ons.io
/t/clients/search_grouped:
get:
tags:
- Client
summary: Searches performed through this method are 'grouped' according to the groups…
description: 'Searches performed through this method are ''grouped'' according to the groups defined in
{@link com.nedap.healthcare.domain.ClientSearchResultGroup}, which value is set on the
{@link com.nedap.healthcare.domain.ClientSearchResult#group} field.'
operationId: ClientAPI.searchGrouped
parameters:
- name: query
in: query
schema:
type: string
- name: employee_id
in: query
schema:
type: string
- name: limit
in: query
schema:
type: integer
format: int32
default: 10
- name: offset
in: query
schema:
type: integer
format: int32
default: 0
- name: include_waiting
in: query
schema:
type: boolean
- name: include_outofcare
in: query
schema:
type: boolean
- name: on_date
in: query
description: The search will be performed for the given date (instead of now)
schema:
type: string
format: date
- name: location_id
in: query
description: Limit the scope of search to within this location (only works when also using employee_id with an Employee that is linked to a User account)
schema:
type: integer
format: int64
- name: X-Cupido-User-Name
in: header
schema:
type: string
- name: X-Cupido-Active-Identity
in: header
schema:
type: string
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/list.ClientSearchResultList'
'404':
description: Employee not found
deprecated: true
x-deprecated-since: 01-03-2026
x-replaced-by: /v0/administration/clients/find_grouped
servers:
- url: https://api-development.ons.io
/t/clients/ids_in_care_in_period:
get:
tags:
- Client
summary: Find clientObjectIds of all clients in care in a given period
operationId: ClientAPI.searchClientIdsInCareInPeriod
parameters:
- name: valid_from
in: query
schema:
type: string
format: date
- name: valid_to
in: query
schema:
type: string
format: date
- name: limit
in: query
schema:
type: integer
format: int32
default: 10
- name: offset
in: query
schema:
type: integer
format: int32
default: 0
- name: X-Cupido-User-Name
in: header
schema:
type: string
- name: X-Cupido-Active-Identity
in: header
schema:
type: string
responses:
'200':
description: Succes
content:
application/json:
schema:
$ref: '#/components/schemas/list.ClientObjectIdList'
'400':
description: Bad request
x-replaced-by: /v0/administration/clients/ids_in_care_in_period
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/clients/in_care_in_period:
get:
tags:
- Client
summary: Find all clients in care in a given period
operationId: ClientAPI.searchInCareInPeriod
parameters:
- name: valid_from
in: query
schema:
type: string
format: date
- name: valid_to
in: query
schema:
type: string
format: date
- name: limit
in: query
schema:
type: integer
format: int32
default: 10
- name: offset
in: query
schema:
type: integer
format: int32
default: 0
- name: X-Cupido-User-Name
in: header
schema:
type: string
- name: X-Cupido-Active-Identity
in: header
schema:
type: string
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.ClientList'
'400':
description: Bad request
x-replaced-by: /v0/administration/clients/in_care_in_period
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/clients/multiple:
get:
tags:
- Client
summary: Method used for requesting multiple Client objects using their ids
operationId: ClientAPI.multiple
parameters:
- name: id
in: query
description: 'array style id''s: id=1&id=2&etc'
explode: true
schema:
type: array
items:
type: integer
format: int64
- name: X-Cupido-User-Name
in: header
schema:
type: string
- name: X-Cupido-Active-Identity
in: header
schema:
type: string
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.ClientList'
x-cupido-common-method: true
x-replaced-by: /v0/administration/clients/multiple
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/clients/search_by/locations/{location_id}:
get:
tags:
- Client
summary: Find clients by location
operationId: ClientAPI.searchByLocationId
parameters:
- name: location_id
in: path
description: Location
required: true
schema:
type: integer
format: int64
- name: offset
in: query
description: number of results to skip
schema:
type: integer
format: int32
default: 0
- name: limit
in: query
description: number of results for one call
schema:
type: integer
format: int32
default: 10
- name: valid_from
in: query
description: starting time
schema:
type: string
format: date
- name: valid_to
in: query
description: end time
schema:
type: string
format: date
- name: X-Cupido-User-Name
in: header
schema:
type: string
- name: X-Cupido-Active-Identity
in: header
schema:
type: string
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.ClientList'
'404':
description: Location not found
x-replaced-by: /v0/administration/clients/search_by_location
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/users/{user_id}/last_visited_clients:
get:
tags:
- Client
summary: Return the last visited Clients of a User corresponding to the given id
operationId: ClientAPI.lastVisitedByUserId
parameters:
- name: user_id
in: path
description: id
required: true
schema:
type: integer
format: int64
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.ClientList'
x-replaced-by: /v0/administration/users/{user_id}/last_visited_clients
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/users/{user_id}/last_visited_clients/{client_id}:
post:
tags:
- Client
summary: Add or update client in favorite table
operationId: ClientAPI.addOrUpdateClientInFavorite
parameters:
- name: user_id
in: path
description: User ID
required: true
schema:
type: integer
format: int64
- name: client_id
in: path
description: Client ID
required: true
schema:
type: integer
format: int64
responses:
'204':
description: No content
'400':
description: User or client id is required
'403':
description: Insufficient rights
'404':
description: User or client not found
x-replaced-by: /v0/administration/users/{user_id}/last_visited_clients/{client_id}
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/omnisearch/clients/searchresult:
get:
tags:
- Client
summary: Client Search via Omnisearch
description: 'Searches performed through this method are ''grouped'' according to the groups defined in
com.nedap.healthcare.domain.ClientSearchResultGroup, which value is set on the
com.nedap.healthcare.domain.ClientSearchResult#group field'
operationId: ClientAPI.omnisearch
parameters:
- name: query
in: query
description: The string to search for
required: true
schema:
type: string
- name: employee_id
in: query
schema:
type: string
- name: limit
in: query
schema:
type: integer
format: int32
default: 10
- name: offset
in: query
schema:
type: integer
format: int32
default: 0
- name: include_waiting
in: query
schema:
type: boolean
default: false
- name: include_out_of_care
in: query
schema:
type: boolean
default: false
- name: on_date
in: query
description: The search will be performed for the given date (instead of now)
schema:
type: string
format: date
- name: location_id
in: query
description: Limit the scope of search to within this location
schema:
type: integer
format: int64
- name: X-Cupido-User-Name
in: header
schema:
type: string
- name: X-Cupido-Active-Identity
in: header
schema:
type: string
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.ClientSearchResultList'
'403':
description: No valid authentication
'404':
description: Not found
'500':
description: Internal server error
'503':
description: Service unavailable
x-replaced-by: /v0/omnisearch/client/search
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/openehr/clients/by_archetype_id/{archetype_id}:
get:
tags:
- Client
summary: Returns the clients (but only the client ids) who have data for the given…
description: 'When querying
an archetype id, this also returns clients with data for subversions of that archetype id.
For example openEHR-EHR-COMPOSITION.berg_balance_scale_report.v1 returns clients with data for
openEHR-EHR-COMPOSITION.berg_balance_scale_report.v1.0.2 and openEHR-EHR-COMPOSITION.berg_balance_scale_report.v1.5.0,
but not for openEHR-EHR-COMPOSITION.berg_balance_scale_report.v2.0.0.
This will take into account data with lifecycle state COMPLETE and INCOMPLETE, but not DELETED.'
operationId: ClientAPI.allByArchetypeId
parameters:
- name: archetype_id
in: path
description: '- archetype id can contain the archetype concept plus any precision of the version, like v1 or v1.1.1'
required: true
schema:
type: string
- name: valid_from
in: query
description: '- begin date of the period'
schema:
type: string
format: date
- name: valid_to
in: query
description: '- end date of the period'
schema:
type: string
format: date
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.ClientList'
x-replaced-by: /v0/openehr_dossier/back_channel/unauthorized/clients/by_archetype_id/{archetype_id}
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/clients/x-stream-connect/data:
get:
tags:
- Client
summary: Return all Client models in a streaming manner
operationId: ClientAPI.streamAll
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.ClientList'
application/x-ndjson:
schema:
$ref: '#/components/schemas/Client'
'400':
description: Could not parse request parameter
'404':
description: Resource not found
'500':
description: Unspecified internal error
x-cupido-common-method: true
x-replaced-by: /v0/xstream/clients/data
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/clients/x-stream-connect/deletes:
get:
tags:
- Client
summary: Return all Client models which where deleted since the date given in the request
description: 'If no date is
given it will return all deleted Client models'
operationId: ClientAPI.streamDeletes
parameters:
- name: since
in: query
required: true
schema:
type: string
format: date-time
example: '2014-12-29T00:00:00.000'
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.ClientList'
application/x-ndjson:
schema:
$ref: '#/components/schemas/Client'
'400':
description: Could not parse request parameter
'404':
description: Resource not found
'500':
description: Unspecified internal error
x-cupido-common-method: true
x-replaced-by: /v0/xstream/clients/deletes
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/clients/x-stream-connect/updates:
get:
tags:
- Client
summary: Return all Client models which where updated since the date given in the request
operationId: ClientAPI.streamUpdates
parameters:
- name: since
in: query
required: true
schema:
type: string
format: date-time
example: '2014-12-29T00:00:00.000'
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.ClientList'
application/x-ndjson:
schema:
$ref: '#/components/schemas/Client'
'400':
description: Could not parse request parameter
'404':
description: Resource not found
'500':
description: Unspecified internal error
x-cupido-common-method: true
x-replaced-by: /v0/xstream/clients/updates
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/v0/administration/clients:
post:
tags:
- Client
summary: Create Client
operationId: ClientAPI.create
parameters:
- name: X-Cupido-User-Name
in: header
schema:
type: string
- name: X-Cupido-Active-Identity
in: header
schema:
type: string
requestBody:
description: Client to create
content:
application/json:
schema:
$ref: '#/components/schemas/Client'
required: true
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/Client'
'400':
description: Validation or persistence problems
x-cupido-common-method: true
x-replacement-for:
- /t/clients
servers:
- url: https://api-development.ons.io
/v0/administration/clients/{employee_id}/last_visited_clients:
get:
tags:
- Client
summary: Returns the last visited clients of an employee based on presence logs
operationId: ClientAPI.lastVisitedClients
parameters:
- name: employee_id
in: path
description: '- employee id'
required: true
schema:
type: integer
format: int64
- name: from_date
in: query
description: '- begin date of period'
required: true
schema:
type: string
format: date
- name: to_date
in: query
description: '- end date of period'
required: true
schema:
type: string
format: date
- name: offset
in: query
description: '- position in the result list to start from'
schema:
type: integer
format: int32
default: 0
- name: limit
in: query
description: '- limit of the result list'
schema:
type: integer
format: int32
default: 10
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.ClientList'
x-replacement-for:
- /t/clients/{employee_id}/last_visited_clients
servers:
- url: https://api-development.ons.io
/v0/administration/clients/{id}:
get:
tags:
- Client
summary: Find a client by their primary key
operationId: ClientAPI.byId
parameters:
- name: id
in: path
description: used for selecting Client
required: true
schema:
type: integer
format: int64
- name: X-Cupido-User-Name
in: header
schema:
type: string
- name: X-Cupido-Active-Identity
in: header
schema:
type: string
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/Client'
'404':
description: Client not found
x-cupido-common-method: true
x-replacement-for:
- /t/clients/{id}
put:
tags:
- Client
summary: Update Client
operationId: ClientAPI.update
parameters:
- name: id
in: path
description: used for selecting Client
required: true
schema:
type: integer
format: int64
- name: X-Cupido-User-Name
in: header
schema:
type: string
- name: X-Cupido-Active-Identity
in: header
schema:
type: string
requestBody:
description: Client to update
content:
application/json:
schema:
$ref: '#/components/schemas/Client'
required: true
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/Client'
'400':
description: Validation or persistence problems, or identification number already exists
'404':
description: Client not found
x-cupido-common-method: true
x-replacement-for:
- /t/clients/{id}
servers:
- url: https://api-development.ons.io
/v0/administration/clients/by_bsn:
get:
tags:
- Client
# --- truncated at 32 KB (74 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nedap/refs/heads/main/openapi/nedap-client-api-openapi.yml