How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Nedap Client API

The Client API from Nedap — 42 operation(s) for client.

Nedap Client API is one of 269 APIs that Nedap publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Clients. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, a getting-started guide, and authentication docs.

This API exposes 44 operations across 42 paths, and defines 13 schemas. It is described by OpenAPI 3.2.0, at version 0.0.0.

Requests are made against a single base URL, https://api-development.ons.io.

44 operations 42 paths 13 schemas 38 GET4 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.0.0
Base URL
https://api.ons.io
Resource Areas
1

Paths & Operations 44

Across 42 paths, the API surfaces 44 operations — 38 GET, 4 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Client 44
POST
/t/clientsdeprecated
Create Client
ClientAPI.create 2 params body → 200400
GET
/t/clients/{employee_id}/last_visited_clientsdeprecated
Returns the last visited clients of an employee based on presence logs
ClientAPI.lastVisitedClients 5 params → 200
GET
/t/clients/{id}deprecated
Find a client by their primary key
ClientAPI.byId 3 params → 200404
PUT
/t/clients/{id}deprecated
Update Client
ClientAPI.update 3 params body → 200400404
GET
/t/clients/by_bsndeprecated
Find a client by its BSN number
ClientAPI.byBSN 3 params → 200404409
GET
/t/clients/by_bsn/{bsn}deprecated
Find a client by its BSN number
ClientAPI.byBSNUnsafe 3 params → 200404409
GET
/t/clients/by_skndeprecated
Find a client by its SKN (strafrechtketennummer)
ClientAPI.bySkn 3 params → 200404
GET
/t/clients/by_uuid/{uuid}deprecated
Find a client by its UUID
ClientAPI.byUUID 3 params → 200404
GET
/t/clients/by_identification_no/{identification_no}deprecated
Find a client based on it's identification number, a logical identifier
ClientAPI.byIdentificationNo 1 param → 200
GET
/t/clients/searchresultdeprecated
Results returned by this call are not grouped, i.e.
ClientAPI.search 10 params → 200404
GET
/t/clients/search_groupeddeprecated
Searches performed through this method are 'grouped' according to the groups…
ClientAPI.searchGrouped 10 params → 200404
GET
/t/clients/ids_in_care_in_perioddeprecated
Find clientObjectIds of all clients in care in a given period
ClientAPI.searchClientIdsInCareInPeriod 6 params → 200400
GET
/t/clients/in_care_in_perioddeprecated
Find all clients in care in a given period
ClientAPI.searchInCareInPeriod 6 params → 200400
GET
/t/clients/multipledeprecated
Method used for requesting multiple Client objects using their ids
ClientAPI.multiple 3 params → 200
GET
/t/clients/search_by/locations/{location_id}deprecated
Find clients by location
ClientAPI.searchByLocationId 7 params → 200404
GET
/t/users/{user_id}/last_visited_clientsdeprecated
Return the last visited Clients of a User corresponding to the given id
ClientAPI.lastVisitedByUserId 1 param → 200
POST
/t/users/{user_id}/last_visited_clients/{client_id}deprecated
Add or update client in favorite table
ClientAPI.addOrUpdateClientInFavorite 2 params → 204400403404
GET
/t/omnisearch/clients/searchresultdeprecated
Client Search via Omnisearch
ClientAPI.omnisearch 10 params → 200403404500503
GET
/t/openehr/clients/by_archetype_id/{archetype_id}deprecated
Returns the clients (but only the client ids) who have data for the given…
ClientAPI.allByArchetypeId 3 params → 200
GET
/t/clients/x-stream-connect/datadeprecated
Return all Client models in a streaming manner
ClientAPI.streamAll → 200400404500
GET
/t/clients/x-stream-connect/deletesdeprecated
Return all Client models which where deleted since the date given in the request
ClientAPI.streamDeletes 1 param → 200400404500
GET
/t/clients/x-stream-connect/updatesdeprecated
Return all Client models which where updated since the date given in the request
ClientAPI.streamUpdates 1 param → 200400404500
POST
/v0/administration/clients
Create Client
postV0AdministrationClients 2 params body → 200400
GET
/v0/administration/clients/{employee_id}/last_visited_clients
Returns the last visited clients of an employee based on presence logs
getV0AdministrationClientsByEmployeeIdLastVisitedClients 5 params → 200
GET
/v0/administration/clients/{id}
Find a client by their primary key
getV0AdministrationClientsById 3 params → 200404
PUT
/v0/administration/clients/{id}
Update Client
putV0AdministrationClientsById 3 params body → 200400404
GET
/v0/administration/clients/by_bsn
Find a client by its BSN number
getV0AdministrationClientsByBsn 3 params → 200404409
GET
/v0/administration/clients/by_bsn/{bsn}deprecated
Find a client by its BSN number
getV0AdministrationClientsByBsnByBsn 3 params → 200404409
GET
/v0/administration/clients/by_skn
Find a client by its SKN (strafrechtketennummer)
getV0AdministrationClientsBySkn 3 params → 200404
GET
/v0/administration/clients/by_uuid/{uuid}
Find a client by its UUID
getV0AdministrationClientsByUuidByUuid 3 params → 200404
GET
/v0/administration/clients/byIdentificationNumber/{identification_no}
Find a client based on it's identification number, a logical identifier
getV0AdministrationClientsByIdentificationNumberByIdentificationNo 1 param → 200
GET
/v0/administration/clients/finddeprecated
Results returned by this call are not grouped, i.e.
getV0AdministrationClientsFind 10 params → 200404
GET
/v0/administration/clients/find_groupeddeprecated
Searches performed through this method are 'grouped' according to the groups…
getV0AdministrationClientsFindGrouped 10 params → 200404
GET
/v0/administration/clients/ids_in_care_in_period
Find clientObjectIds of all clients in care in a given period
getV0AdministrationClientsIdsInCareInPeriod 6 params → 200400
GET
/v0/administration/clients/in_care_in_period
Find all clients in care in a given period
getV0AdministrationClientsInCareInPeriod 6 params → 200400
GET
/v0/administration/clients/multiple
Method used for requesting multiple Client objects using their ids
getV0AdministrationClientsMultiple 3 params → 200
GET
/v0/administration/clients/search_by_location
Find clients by location
getV0AdministrationClientsSearchByLocation 7 params → 200404
GET
/v0/administration/users/{user_id}/last_visited_clients
Return the last visited Clients of a User corresponding to the given id
getV0AdministrationUsersByUserIdLastVisitedClients 1 param → 200
POST
/v0/administration/users/{user_id}/last_visited_clients/{client_id}
Add or update client in favorite table
postV0AdministrationUsersByUserIdLastVisitedClientsByClientId 2 params → 204400403404
GET
/v0/omnisearch/client/search
Client Search via Omnisearch
getV0OmnisearchClientSearch 10 params → 200403404500503
GET
/v0/openehr_dossier/back_channel/unauthorized/clients/by_archetype_id/{archetype_id}
Returns the clients (but only the client ids) who have data for the given…
getV0OpenehrDossierBackChannelUnauthorizedClientsByArchetypeIdByArchetypeId 3 params → 200
GET
/v0/xstream/clients/data
Return all Client models in a streaming manner
getV0XstreamClientsData → 200400404500
GET
/v0/xstream/clients/deletes
Return all Client models which where deleted since the date given in the request
getV0XstreamClientsDeletes 1 param → 200400404500
GET
/v0/xstream/clients/updates
Return all Client models which where updated since the date given in the request
getV0XstreamClientsUpdates 1 param → 200400404500

Schemas 13

The contract defines 13 schemas that model the data the API accepts and returns. The most detailed are Client (24 properties), Person (22 properties), ClientSearchResult (19 properties), CareAllocation (9 properties). Each schema is shown below with its type and property counts.

list.ClientSearchResultList
object
ClientSearchResultList model (no description)
1 property
list.ClientObjectIdList
object
List of clientObjectIds
1 property
GenderIdentityType
string
Predefined type of gender identity. MALE: 'man', FEMALE: 'vrouw', NONBINARY: 'non-binair'
Pronouns
object
The usage of this schema is deprecated and has been replaced by PronounsType.
2 properties
ClientSearchResultGroup
string
The group to which this result belongs. This is only set after calling the 'searchGrouped' API.
list.ClientList
object
ClientList model (no description)
1 property
Person
object
Common attributes for Client and Employee.
22 properties
ClientSearchResult
object
Search Result after querying OnsAdmin
19 properties
ClientObjectId
object
id of a Client object
1 property 1 required
PronounsType
string
Predefined type of pronouns: SHEHER: 'zij/haar', HEHIS: 'hij/hem', WHOTHEIR: 'die/diens', THEMTHEIRS: 'hen/hun'
CareAllocation
object
CareAllocation model (no description)
9 properties 2 required
Client
object
Client registered on Cupido system.
24 properties
GenderIdentity
object
The usage of this schema is deprecated and has been replaced by GenderIdentityType.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

nedap-client-api-openapi.yml Raw ↑

Other APIs Nedap publishes across the network.

Nedap Retail iD Cloud API
Nedap Address API
Nedap Admin.Background Image API
Nedap Admin.License API
Nedap Admin.Logo Image API
Nedap Admin.Timesheet Config API
Nedap Admin.Version API
Nedap Agbcode API
Nedap Agenda.Agenda Occurrence API
Nedap Agenda.Agenda Series API
Nedap Agenda.Client Absence Occurrence API
Nedap Agenda.Label API
Where this information came from

This is an independent, third-party profile of Nedap Client API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.