The Employee API from Nedap — 28 operation(s) for employee.
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-employee-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 Employee API
version: 0.0.0
description: 'Operations tagged Employee 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: Employee
paths:
/t/clients/{client_id}/finance_types/{finance_type_id}/coordinating_practitioner:
get:
tags:
- Employee
summary: Find the coordinating practitioner by client, finance type and date
operationId: EmployeeAPI.coordinatingPractitionerByClientFinanceTypeDate
parameters:
- name: client_id
in: path
required: true
schema:
type: integer
format: int64
- name: finance_type_id
in: path
description: 'The finance type of the care order in which the coordinating practitioner is defined.
Finance types:
* 14 - GGZ ZPM
* 15 - FZ ZPM'
required: true
schema:
type: integer
format: int64
- name: date
in: query
description: date
required: true
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/Employee'
'400':
description: Date is required, a valid finance_type_id is required, a valid client_id is required
'404':
description: No careorder found or no employee found for given parameters
'409':
description: Two or more coordinating practitioners were found
x-replaced-by: /v0/administration/clients/{client_id}/finance_types/{finance_type_id}/coordinating_practitioner
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/employees:
post:
tags:
- Employee
summary: Create Employee
operationId: EmployeeAPI.create
requestBody:
description: Employee to create.
content:
application/json:
schema:
$ref: '#/components/schemas/Employee'
required: true
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/Employee'
'400':
description: Validation errors, or missing identification number when automatic numbering is not enabled
x-cupido-common-method: true
x-replaced-by: /v0/administration/employees
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/employees/{employee_id}:
get:
tags:
- Employee
summary: Find employee by employee object id
operationId: EmployeeAPI.byId
parameters:
- name: employee_id
in: path
description: The employee object id of the employee to find.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/Employee'
x-cupido-common-method: true
x-replaced-by: /v0/administration/employees/{employee_id}
deprecated: true
x-deprecated-since: 19-11-2025
put:
tags:
- Employee
summary: Updates an employee
operationId: EmployeeAPI.update
parameters:
- name: employee_id
in: path
description: id of the employee to update
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Employee'
required: true
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/Employee'
x-cupido-common-method: true
x-replaced-by: /v0/administration/employees/{employee_id}
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/employees/{employee_id}/bank_account:
get:
tags:
- Employee
summary: Return the bank account assigned to the Employee corresponding to the given id
operationId: EmployeeAPI.bankAccount
parameters:
- name: employee_id
in: path
description: the id of the employee
required: true
schema:
type: integer
format: int64
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/BankAccount'
x-replaced-by: /v0/administration/employees/{employee_id}/bank_account
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/employees/by_email:
get:
tags:
- Employee
summary: Return the employees with the given emailaddress
description: Note that passing an empty email query parameter is technically possible, but will result in finding all employees that have no email address assigned
operationId: EmployeeAPI.byEmail
parameters:
- name: email
in: query
description: emailaddress
schema:
type: string
- name: include_home_email
in: query
description: if `true` also Employees with the given home emailaddress are included in the result. When omitted, the value is set to `false`
schema:
type: boolean
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.EmployeeList'
x-replaced-by: /v0/administration/employees/by_email
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/employees/by_identification_no/{identification_no}:
get:
tags:
- Employee
summary: Return the Employee corresponding to the given identification number
operationId: EmployeeAPI.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/Employee'
x-replaced-by: /v0/administration/employees/by_identification_no/{identification_no}
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/employees/by_uuid/{uuid}:
get:
tags:
- Employee
summary: Return the Employee corresponding to the given uuid
operationId: EmployeeAPI.byUuid
parameters:
- name: uuid
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/Employee'
'404':
description: Employee not found
x-replaced-by: /v0/administration/employees/by_uuid/{uuid}
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/employees/search:
get:
tags:
- Employee
summary: Search for employees
operationId: EmployeeAPI.search
parameters:
- name: query
in: query
description: query
schema:
type: string
- name: employee
in: query
description: the employee for which the search action is done
schema:
type: integer
format: int64
- name: limit
in: query
description: limit the amount of results by
schema:
type: integer
format: int32
default: 10
- name: offset
in: query
description: start at the given offset
schema:
type: integer
format: int32
default: 0
- name: out_of_duty
in: query
description: including employees out of duty
schema:
type: boolean
- name: exclude_first_name
in: query
description: exclude first name in the search
required: false
schema:
type: boolean
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.EmployeeList'
x-replaced-by: /v0/administration/employees/find
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/employees/multiple:
get:
tags:
- Employee
summary: Method used for requesting multiple Employee objects using their ids
description: 'Method used for requesting multiple Employee objects using
their ids.'
operationId: EmployeeAPI.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
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.EmployeeList'
x-cupido-common-method: true
x-replaced-by: /v0/administration/employees/multiple
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/employees/search_by/teams/{id}:
get:
tags:
- Employee
summary: Return the Employees who are a member of team corresponding to the given id
operationId: EmployeeAPI.searchByTeamId
parameters:
- name: id
in: path
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
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.EmployeeList'
x-replaced-by: /v0/administration/employees/search_by_team
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/users/{user_id}/last_visited_employees:
get:
tags:
- Employee
summary: Return the last visited Employees of a User corresponding to the given id
operationId: EmployeeAPI.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.EmployeeList'
x-replaced-by: /v0/administration/users/{user_id}/last_visited_employees
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/employees/x-stream-connect/data:
get:
tags:
- Employee
summary: Return all Employee models in a streaming manner
operationId: EmployeeAPI.streamAll
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.EmployeeList'
application/x-ndjson:
schema:
$ref: '#/components/schemas/Employee'
'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/employees/data
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/employees/x-stream-connect/deletes:
get:
tags:
- Employee
summary: Return all Employee models which where deleted since the date given in the…
description: If no date is given it will return all deleted Employee models
operationId: EmployeeAPI.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.EmployeeList'
application/x-ndjson:
schema:
$ref: '#/components/schemas/Employee'
'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/employees/deletes
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/t/employees/x-stream-connect/updates:
get:
tags:
- Employee
summary: Return all Employee models which where updated since the date given in the…
operationId: EmployeeAPI.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.EmployeeList'
application/x-ndjson:
schema:
$ref: '#/components/schemas/Employee'
'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/employees/updates
deprecated: true
x-deprecated-since: 19-11-2025
servers:
- url: https://api-development.ons.io
/v0/administration/clients/{client_id}/finance_types/{finance_type_id}/coordinating_practitioner:
get:
tags:
- Employee
summary: Find the coordinating practitioner by client, finance type and date
operationId: EmployeeAPI.coordinatingPractitionerByClientFinanceTypeDate
parameters:
- name: client_id
in: path
required: true
schema:
type: integer
format: int64
- name: finance_type_id
in: path
description: 'The finance type of the care order in which the coordinating practitioner is defined.
Finance types:
* 14 - GGZ ZPM
* 15 - FZ ZPM'
required: true
schema:
type: integer
format: int64
- name: date
in: query
description: date
required: true
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/Employee'
'400':
description: Date is required, a valid finance_type_id is required, a valid client_id is required
'404':
description: No careorder found or no employee found for given parameters
'409':
description: Two or more coordinating practitioners were found
x-replacement-for:
- /t/clients/{client_id}/finance_types/{finance_type_id}/coordinating_practitioner
servers:
- url: https://api-development.ons.io
/v0/administration/employees:
post:
tags:
- Employee
summary: Create Employee
operationId: EmployeeAPI.create
requestBody:
description: Employee to create.
content:
application/json:
schema:
$ref: '#/components/schemas/Employee'
required: true
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/Employee'
'400':
description: Validation errors, or missing identification number when automatic numbering is not enabled
x-cupido-common-method: true
x-replacement-for:
- /t/employees
servers:
- url: https://api-development.ons.io
/v0/administration/employees/{employee_id}:
get:
tags:
- Employee
summary: Find employee by employee object id
operationId: EmployeeAPI.byId
parameters:
- name: employee_id
in: path
description: The employee object id of the employee to find.
required: true
schema:
type: integer
format: int64
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/Employee'
x-cupido-common-method: true
x-replacement-for:
- /t/employees/{employee_id}
put:
tags:
- Employee
summary: Updates an employee
operationId: EmployeeAPI.update
parameters:
- name: employee_id
in: path
description: id of the employee to update
required: true
schema:
type: integer
format: int64
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Employee'
required: true
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/Employee'
x-cupido-common-method: true
x-replacement-for:
- /t/employees/{employee_id}
servers:
- url: https://api-development.ons.io
/v0/administration/employees/{employee_id}/bank_account:
get:
tags:
- Employee
summary: Return the bank account assigned to the Employee corresponding to the given id
operationId: EmployeeAPI.bankAccount
parameters:
- name: employee_id
in: path
description: the id of the employee
required: true
schema:
type: integer
format: int64
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/BankAccount'
x-replacement-for:
- /t/employees/{employee_id}/bank_account
servers:
- url: https://api-development.ons.io
/v0/administration/employees/by_email:
get:
tags:
- Employee
summary: Return the employees with the given emailaddress
description: Note that passing an empty email query parameter is technically possible, but will result in finding all employees that have no email address assigned
operationId: EmployeeAPI.byEmail
parameters:
- name: email
in: query
description: emailaddress
schema:
type: string
- name: include_home_email
in: query
description: if `true` also Employees with the given home emailaddress are included in the result. When omitted, the value is set to `false`
schema:
type: boolean
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.EmployeeList'
x-replacement-for:
- /t/employees/by_email
servers:
- url: https://api-development.ons.io
/v0/administration/employees/by_identification_no/{identification_no}:
get:
tags:
- Employee
summary: Return the Employee corresponding to the given identification number
operationId: EmployeeAPI.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/Employee'
x-replacement-for:
- /t/employees/by_identification_no/{identification_no}
servers:
- url: https://api-development.ons.io
/v0/administration/employees/by_uuid/{uuid}:
get:
tags:
- Employee
summary: Return the Employee corresponding to the given uuid
operationId: EmployeeAPI.byUuid
parameters:
- name: uuid
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/Employee'
'404':
description: Employee not found
x-replacement-for:
- /t/employees/by_uuid/{uuid}
servers:
- url: https://api-development.ons.io
/v0/administration/employees/find:
get:
tags:
- Employee
summary: Search for employees
operationId: EmployeeAPI.search
parameters:
- name: query
in: query
description: query
schema:
type: string
- name: employee
in: query
description: the employee for which the search action is done
schema:
type: integer
format: int64
- name: limit
in: query
description: limit the amount of results by
schema:
type: integer
format: int32
default: 10
- name: offset
in: query
description: start at the given offset
schema:
type: integer
format: int32
default: 0
- name: out_of_duty
in: query
description: including employees out of duty
schema:
type: boolean
- name: exclude_first_name
in: query
description: exclude first name in the search
required: false
schema:
type: boolean
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.EmployeeList'
x-replacement-for:
- /t/employees/search
servers:
- url: https://api-development.ons.io
/v0/administration/employees/multiple:
get:
tags:
- Employee
summary: Method used for requesting multiple Employee objects using their ids
description: 'Method used for requesting multiple Employee objects using
their ids.'
operationId: EmployeeAPI.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
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.EmployeeList'
x-cupido-common-method: true
x-replacement-for:
- /t/employees/multiple
servers:
- url: https://api-development.ons.io
/v0/administration/employees/search_by_team:
get:
tags:
- Employee
summary: Return the Employees who are a member of team corresponding to the given id
operationId: EmployeeAPI.searchByTeamId
parameters:
- name: team_id
in: query
required: true
schema:
type: integer
format: int64
x-original-parameter:
name: id
in: path
- 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
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.EmployeeList'
x-replacement-for:
- /t/employees/search_by/teams/{id}
servers:
- url: https://api-development.ons.io
/v0/administration/users/{user_id}/last_visited_employees:
get:
tags:
- Employee
summary: Return the last visited Employees of a User corresponding to the given id
operationId: EmployeeAPI.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.EmployeeList'
x-replacement-for:
- /t/users/{user_id}/last_visited_employees
servers:
- url: https://api-development.ons.io
/v0/xstream/employees/data:
get:
tags:
- Employee
summary: Return all Employee models in a streaming manner
operationId: EmployeeAPI.streamAll
responses:
'200':
description: No response was specified
content:
application/json:
schema:
$ref: '#/components/schemas/list.EmployeeList'
application/x-ndjson:
schema:
$ref: '#/components/schemas/Employee'
'400':
description: Could not parse request parameter
'404':
description: Resource not found
'500':
description: Unspecified internal error
x-cupido-common-method: true
x-replacement-for:
- /t/employees/x-stream-connect/data
servers:
- url: https://api-development.ons.io
/v0/xstream/employees/deletes:
get:
tags:
- Employee
summary: Return all Employee models which where deleted since the date given in the…
description: If no date is given it will return all deleted Employee models
operationId: EmployeeAPI.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.EmployeeList'
application/x-ndjson:
schema:
$ref: '#/components/schemas/Employee'
'400':
description: Could not parse request parameter
'404':
description: Resource not found
'500':
description: Unspecified internal error
x-cupido-common-method: true
x-replacement-for:
- /t/employees/x-stream-connect/deletes
servers:
- url: https://api-development.ons.io
/v0/xstream/employees/updates:
get:
tags:
- Employee
summary: Return all Employee models which where updated since the date given in the…
operationId: EmployeeAPI.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.EmployeeList'
application/x-ndjson:
schema:
$ref: '#/components/schemas/Employee'
'400':
description: Could not parse request parameter
'404':
description: Resource not found
'500':
description: Unspecified internal error
x-cupido-common-method: true
x-replacement-for:
- /t/employees/x-stream-connect/updates
servers:
- url: https://api-development.ons.io
components:
schemas:
BankAccount:
type: object
properties:
id:
type: integer
format: int64
x-cupido-id: true
number:
type: string
nameOfOwner:
type: string
cityOfOwner:
type: string
iban:
type: string
bic:
type: string
creditBankAccount:
type: boolean
authorizationDate:
type: string
format: date
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
description: BankAccount model (no description)
example:
id: 1
number: Dummy
nameOfOwner: Dummy
cityOfOwner: Dummy
iban: Dummy
bic: Dummy
creditBankAccount: false
authorizationDate: '2016-01-01'
createdAt: '2016-01-01T12:00:00.000+01:00'
updatedAt: '2016-01-01T12:00:00.000+01:00'
xml:
name: bankAccount
list.EmployeeList:
type: object
properties:
employees:
type: array
items:
$ref: '#/components/schemas/Employee'
xml:
name: employee
description: EmployeeList model (no description)
example:
employees:
- id: 1
firstName: Mike
dateOfBirth: '2012-08-02'
birthName: Wazowski
xml:
name: employees
Employee:
type: object
allOf:
- $ref: '#/components/schemas/Person'
properties:
contractId:
type: string
description: Deprecated, this field is never set, use Contract APIs.
deprecated: true
mobilePhoneNumber:
type: string
description: Deprecated, this field is never set.
deprecated: true
authenticationMobilePh
# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nedap/refs/heads/main/openapi/nedap-employee-api-openapi.yml