Jump to Content

API Reference

v1.0API Reference

All

Pages

Start typing to search…

General Information

Getting Started & API key
Download OpenAPI specification file
Detailed Filed descriptions and additional documentation [historic]
Request more endpoints

Credentially REST API

Profile Fields
Employee
Documents
References
Questionnaires
- /api/v1/employees/{employeePublicId}/questionnairesget
organisation-dbs-resource
- /api/v2/organisations/{organisationId}/employees/{employeePublicId}/dbsget
- /api/v2/organisations/{organisationId}/employees/{employeePublicId}/dbs/{dbsCheckId}get
NHS England GP Performers List
- /api/v2/employees/{employeePublicId}/performerget
Compliance Packages
- /api/v1/organisations/{organisationId}/employees/{employeePublicId}/compliance-packagesget
Document Types
- /api/v1/document-typesget
Organisaton Roles
- /api/organisations/{organisationId}/rolesget
Right To Work
- /api/organisations/{organisationId}/employees/{employeePublicId}/right-to-workget

Powered by

General Information

Getting Started & API key
Download OpenAPI specification file
Detailed Filed descriptions and additional documentation [historic]
Request more endpoints

Credentially REST API

Profile Fields
Employee
Documents
References
Questionnaires
- /api/v1/employees/{employeePublicId}/questionnairesget
organisation-dbs-resource
- /api/v2/organisations/{organisationId}/employees/{employeePublicId}/dbsget
- /api/v2/organisations/{organisationId}/employees/{employeePublicId}/dbs/{dbsCheckId}get
NHS England GP Performers List
- /api/v2/employees/{employeePublicId}/performerget
Compliance Packages
- /api/v1/organisations/{organisationId}/employees/{employeePublicId}/compliance-packagesget
Document Types
- /api/v1/document-typesget
Organisaton Roles
- /api/organisations/{organisationId}/rolesget
Right To Work
- /api/organisations/{organisationId}/employees/{employeePublicId}/right-to-workget

Powered by

/api/v1/employees

get https://app.credentially.io/mp/api/v1/employees

Language

Credentials

Click Try It! to start a request and see the response here!