Retrieve the credentials associated with a professional in the Propelus system.
Get the professional's credentials using professionalId as the unique identifier.
Endpoint:
HTTP Method: GET
Path: /v2/professionals/{professionalId}/credentials
Server URL: https://api.propelus.com
Developer Docs: https://propelus.com/developer/monitoring/GetProfessionalCredentials
Authentication
Two header-based authentication methods are required:
| Header | Type | In | Description |
| x-api-key | token | header | API key credential |
| x-client-id | token | header | Client identifier credential |
Path Parameters
| Parameter | Type | Required | Description |
| professionalId | string (UUID) | Yes |
Unique identifier for the professional. |
Query Parameters
| Parameter | Type | Required | Description |
| page | integer | No | Page number for pagination. Default 1. Range: 1 ≤ value ≤ 100. |
| perPage | integer | No | Number of items per page. Default 10. Range: 1 ≤ value ≤ 100. |
Example Request — JSON
fetch("https://api.propelus.com/v2/professionals/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a/credentials", {
method: "GET",
headers: {
"x-api-key": "<your-api-key>",
"x-client-id": "<your-client-id>"
}
})Example Request — cURL
curl -X GET "https://api.propelus.com/v2/professionals/628fc8e2-ee7e-4779-9eb7-d980e7a92f3a/credentials" \
-H "x-api-key: <your-api-key>" \
-H "x-client-id: <your-client-id>"Responses
200 — Success
Returns a paginated list of the professional's credentials, with count, total, and nextPage / prevPage links.
{
"count": 1,
"total": 1,
"credentials": [
{
"id": "628fc8e2-ee7e-4779-9eb7-d980e7a92f3a",
"number": "string",
"code": "RN",
"state": "CA",
"certState": "CA",
"customProperties": {
"property1": "string",
"property2": "string"
}
}
],
"nextPage": "/v2/professionals/{id}/credentials?page=3&perPage=10",
"prevPage": "/v2/professionals/{id}/credentials?page=2&perPage=10"
}Error Responses
Standardized error bodies. Validation-style errors include an errors array; each item contains detail, pointer, parameter, header, and code: https://propelus.com/developer/monitoring/GetProfessionalCredentials#response-body
400 — Bad Request
401 — Unauthorized
403 — Forbidden
404 — Not Found
4XX — Client Error
5XX — Server Error