{
  "opencollection": "1.0.0",
  "info": {
    "name": "Credentially Public Compliance-packages Profiles API",
    "version": "2.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Profiles",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List Profile Tags",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.credentially.io/gateway/api/profile/:profileId/tags",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "profileId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Returns the tags currently assigned to a profile.\n\n**Rate Limit:** `load-profile-tags` (100 req / 1s)"
        },
        {
          "info": {
            "name": "Set Profile Tags",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://app.credentially.io/gateway/api/profile/:profileId/tags",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "profileId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Replaces the full set of tags on a profile with the supplied tags. Send an empty array to clear all tags.\n\n**Rate Limit:** `load-profile-tags` (100 req / 1s)"
        },
        {
          "info": {
            "name": "Force-activate Profile",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://app.credentially.io/gateway/api/profile/:profileId/force-activate",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "profileId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Forces a not-yet-active candidate to ACTIVE, bypassing the invitation-acceptance step: an IMPORTED candidate (added but never invited) or an INVITED candidate (invited but not yet accepted) becomes ACTIVE immediately, so they can be emailed and can sign in. Distinct from PUT /{profileId}/activate, which only reactivates a previously ARCHIVED profile. Idempotent on profiles that are already ACTIVE.\n\n**Rate Limit:** `force-activate-profile` (25 req / 1s)"
        },
        {
          "info": {
            "name": "Archive Profile",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://app.credentially.io/gateway/api/profile/:profileId/archive",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "profileId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Archives a profile within the organisation.\n\n**Rate Limit:** `archive-profile` (25 req / 1s)"
        },
        {
          "info": {
            "name": "Activate Profile (un-archive)",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://app.credentially.io/gateway/api/profile/:profileId/activate",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "profileId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Reactivates a previously ARCHIVED profile (reverses archive). This does NOT activate a candidate who was never invited or has not yet accepted their invitation — for that use PUT /{profileId}/force-activate.\n\n**Rate Limit:** `activate-profile` (25 req / 1s)"
        },
        {
          "info": {
            "name": "Load Profiles",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.credentially.io/gateway/api/profile",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "page",
                "value": "",
                "type": "query"
              },
              {
                "name": "size",
                "value": "",
                "type": "query"
              },
              {
                "name": "name",
                "value": "",
                "type": "query",
                "description": "Smart search of first name, last name and email"
              },
              {
                "name": "complianceStatus",
                "value": "",
                "type": "query",
                "description": "Compliance status"
              },
              {
                "name": "complianceTag",
                "value": "",
                "type": "query"
              },
              {
                "name": "groups",
                "value": "",
                "type": "query"
              },
              {
                "name": "jobPositionStatus",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Fetches a paginated list of profiles for the organisation.\n\n**Rate Limit:** `create-profile` (25 req / 1s)"
        },
        {
          "info": {
            "name": "Create Profile",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://app.credentially.io/gateway/api/profile",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Creates a new profile and optionally populates custom fields in a single transaction.\n\n**Rate Limit:** `create-profile` (25 req / 1s)"
        },
        {
          "info": {
            "name": "Update Profile Fields",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://app.credentially.io/gateway/api/profile",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Updates fields for an existing profile identified by email.\n\n**Rate Limit:** `create-profile` (25 req / 1s)"
        },
        {
          "info": {
            "name": "Load Profile Notes",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.credentially.io/gateway/api/profile/:profileId/notes",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "profileId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Loads notes for a profile.\n\n**Rate Limit:** `load-profile-notes` (100 req / 1s)"
        },
        {
          "info": {
            "name": "Create Profile Note",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://app.credentially.io/gateway/api/profile/:profileId/notes",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "profileId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Creates a note for a profile.\n\n**Rate Limit:** `load-profile-notes` (100 req / 1s)"
        },
        {
          "info": {
            "name": "Get Profile by ID",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.credentially.io/gateway/api/profile/:profileId",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "profileId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Fetches detailed profile information for a profile by their ID, including enriched custom fields.\n\n**Rate Limit:** `profile-by-id` (100 req / 1s)"
        },
        {
          "info": {
            "name": "Delete Profile",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://app.credentially.io/gateway/api/profile/:profileId",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "profileId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Deletes a profile from the organisation.\n\n**Rate Limit:** `profile-by-id` (100 req / 1s)"
        },
        {
          "info": {
            "name": "Get Profile Metadata",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.credentially.io/gateway/api/profile/metadata",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Fetches and aggregates profile metadata fields (schema) and available roles for the organisation.\n\n**Rate Limit:** `profile-metadata` (100 req / 1s)"
        },
        {
          "info": {
            "name": "Get Profile by Email",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.credentially.io/gateway/api/profile/find",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "email",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Fetches detailed profile information, including enriched custom fields.\n\n**Rate Limit:** `profile-by-email` (100 req / 1s)"
        },
        {
          "info": {
            "name": "List All Profiles (Lightweight)",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.credentially.io/gateway/api/profile/all",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Fetches a non-paginated list of all profiles for the organisation with lightweight information.\n\n**Rate Limit:** `load-all-profiles` (5 req / 1s)"
        },
        {
          "info": {
            "name": "Remove Profile Tag",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://app.credentially.io/gateway/api/profile/:profileId/tags/:tagName",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "profileId",
                "value": "",
                "type": "path"
              },
              {
                "name": "tagName",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Removes a single tag from a profile. The tag name must be URL-encoded.\n\n**Rate Limit:** `delete-profile-tag` (25 req / 1s)"
        },
        {
          "info": {
            "name": "Delete Profile Note",
            "type": "http"
          },
          "http": {
            "method": "DELETE",
            "url": "https://app.credentially.io/gateway/api/profile/:profileId/notes/:noteId",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "profileId",
                "value": "",
                "type": "path"
              },
              {
                "name": "noteId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Deletes a note from a profile.\n\n**Rate Limit:** `delete-profile-note` (25 req / 1s)"
        }
      ]
    }
  ],
  "bundled": true
}