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
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Credentially

Credentially Profiles API

Profile management proxy endpoints

Documentation Provider Profile APIs.io OpenAPI GitHub

Credentially Profiles API is one of 21 APIs that Credentially publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Profiles. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 17 operations across 12 paths, and defines 34 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://app.credentially.io/gateway.

17 operations 12 paths 34 schemas 3 DELETE7 GET1 PATCH1 POST5 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://app.credentially.io/gateway
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Credentially Profiles API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer-key).

Paths & Operations 17

Across 12 paths, the API surfaces 17 operations — 3 DELETE, 7 GET, 1 PATCH, 1 POST, 5 PUT. Each is listed below with its method, path, parameters, and response codes.

Profiles 17

Profile management proxy endpoints

GET
/api/profile/{profileId}/tags
List Profile Tags
loadProfileTags 2 params → 200404500429
PUT
/api/profile/{profileId}/tags
Set Profile Tags
updateProfileTags 2 params body → 200400404500429
PUT
/api/profile/{profileId}/force-activate
Force-activate Profile
forceActivateProfile 2 params → 200404500429
PUT
/api/profile/{profileId}/archive
Archive Profile
archiveProfile 2 params → 200404500429
PUT
/api/profile/{profileId}/activate
Activate Profile (un-archive)
activateProfile 2 params → 200404500429
GET
/api/profile
Load Profiles
loadProfiles 8 params → 200500429
PUT
/api/profile
Create Profile
createProfile 1 param body → 201400500429
PATCH
/api/profile
Update Profile Fields
updateProfileFields 1 param body → 200404500429
GET
/api/profile/{profileId}/notes
Load Profile Notes
loadProfileNotes 2 params → 200404500429
POST
/api/profile/{profileId}/notes
Create Profile Note
createProfileNote 2 params body → 201400404500429
GET
/api/profile/{profileId}
Get Profile by ID
getProfileById 2 params → 200404500429
DELETE
/api/profile/{profileId}
Delete Profile
deleteProfile 2 params → 204404500429
GET
/api/profile/metadata
Get Profile Metadata
getProfileMetadata 1 param → 200500429
GET
/api/profile/find
Get Profile by Email
getProfileByEmail 2 params → 200404500429
GET
/api/profile/all
List All Profiles (Lightweight)
loadAllProfiles 1 param → 200500429
DELETE
/api/profile/{profileId}/tags/{tagName}
Remove Profile Tag
deleteProfileTag 3 params → 200404500429
DELETE
/api/profile/{profileId}/notes/{noteId}
Delete Profile Note
deleteProfileNote 3 params → 204404500429

Schemas 34

The contract defines 34 schemas that model the data the API accepts and returns. The most detailed are GmcRegistrationDetailsDto (48 properties), ProfileDetailDto (25 properties), ProfileDto (24 properties), HcpcRegistrationDetailsDto (15 properties). Each schema is shown below with its type and property counts.

CreateProfileNoteRequestDto
object
Request body for creating a profile note.
2 properties 1 required
GmcRegistrationDetailsDto
object
48 properties
CreateProfileRequestDto
object
12 properties 2 required
ProfileDetailDto
object
25 properties
ProfileLightDto
object
5 properties
ChecklistStepStatusDto
object
12 properties
JobPositionDto
object
12 properties
HcpcRegistrationDetailsDto
object
15 properties
ProfileListPageDto
object
5 properties
OrganisationRoleDto
object
8 properties
CustomFieldDto
object
3 properties
NmcQualificationDto
object
5 properties
UpdateProfileFieldsRequestDto
object
3 properties 1 required
ChecklistStepStatusApprovalDto
object
2 properties
GradeDto
object
2 properties
UserTitleDto
object
2 properties
ProfileDto
object
24 properties
CreateProfileResponseDto
object
2 properties
RoleDto
object
2 properties
OrganisationMetadataDto
object
2 properties
ProfileMetadataResultDto
object
2 properties
ProfessionalRegistrationDto
object
11 properties
UpdateProfileTagsRequestDto
object
Request body for replacing the full set of tags on a profile.
1 property 1 required
EmployeeBasicDto
object
4 properties
ChecklistAssignmentDto
object
3 properties
NmcRegistrationDetailsDto
object
5 properties
RoleExtendedDto
object
6 properties
OrganisationGroupDto
object
2 properties
CustomFieldInputDto
object
2 properties
ConditionsDetailDto
object
3 properties
ProfileNoteDto
object
4 properties
ComplianceTagDto
object
2 properties
HistoryActorDto
object
5 properties
ChecklistAssignmentDetailDto
object
9 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

credentially-profiles-api-openapi.yml Raw ↑

Other APIs Credentially publishes across the network.

Credentially Compliance-packages API
AE Profile APIs.io
Credentially DBS API
AE Profile APIs.io
Credentially Dictionary API
AE Profile APIs.io
Credentially Document Auto-fill API
AE Profile APIs.io
Credentially Documents API
AE Profile APIs.io
Credentially Employee Placements API
AE Profile APIs.io
Credentially Jurisdictions API
AE Profile APIs.io
Credentially Location Types API
AE Profile APIs.io
Credentially Locations API
AE Profile APIs.io
Credentially Meta API
AE Profile APIs.io
Credentially Organisation Groups API
AE Profile APIs.io
Credentially Placement Notes API
AE Profile APIs.io
#Profiles
← Back to C APIs
API Details
ID
credentially:credentially-profiles-api
Base URL
https://app.credentially.io/gateway
Docs
https://credentially.readme.io/reference/getting-started-with-your-api
Provider
Credentially
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=credentially-profiles-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/credentially-profiles-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Credentially Profiles 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.