Propelus
Monitoring

List Professionals

Retrieves a paginated list of professionals.

GET
/v2/professionals

Authorization

apiKey clientId
x-api-key<token>

In: header

x-client-id<token>

In: header

Query Parameters

page?integer

Page number for pagination.

perPage?integer

Number of items per page.

externalId?string

Filter results by the foreign key identifier from the customer's system.

orderBy?string

Sort results by a single field and direction. Format: field:ASC or field:DESC. Direction defaults to ASC if omitted. Valid fields: id, externalId, name.first, name.middle, name.last, name.full, email, dob, npi. Name fields use the same nested paths as the professional response (e.g. name.first). name.full is present on every professional created through this API (derived for individuals, provided for companies), so it sorts the whole mixed list alphabetically — note it starts with the first name for individuals. Sorting by a name part (name.first, etc.) groups full-name-only professionals together as empty values, since they have no parts.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v2/professionals?orderBy=name.last%3ADESC"
{
  "count": 0,
  "total": 0,
  "professionals": [
    {
      "id": "628fc8e2-ee7e-4779-9eb7-d980e7a92f3a",
      "externalId": "T-100",
      "dob": "19770428",
      "ssn": "000482915",
      "npi": "1739204857",
      "address": {
        "line1": "string",
        "line2": "string",
        "city": "string",
        "state": "st",
        "zip": "strin"
      },
      "email": "user@example.com",
      "customProperties": {
        "property1": "string",
        "property2": "string"
      },
      "name": {
        "prefix": "Dr.",
        "first": "string",
        "middle": "string",
        "last": "string",
        "suffix": "string",
        "full": "Jane A Smith"
      },
      "alias": {
        "prefix": "Dr.",
        "first": "string",
        "middle": "string",
        "last": "string",
        "suffix": "string",
        "full": "Jane A Smith"
      }
    }
  ],
  "nextPage": "/v2/professionals?page=3&perPage=10",
  "prevPage": "/v2/professionals?page=1&perPage=10"
}
{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}
{
  "status": 400,
  "code": "missing_fields",
  "detail": "string",
  "errors": [
    {
      "detail": "string",
      "pointer": "string",
      "parameter": "string",
      "header": "string",
      "code": "string"
    }
  ]
}
{
  "status": 429,
  "detail": "string",
  "code": "f5d62b05-370e-48be-a755-8675ca146431"
}
{
  "status": 500,
  "detail": "string",
  "code": "unexpected_error"
}

Create a Professional POST

The first step in enrolling a professional and/or their credentials in monitoring is to create the professional in the Propelus system. From there, you will complete steps to create the credentials and select the product you'd like to enroll them in. Create a professional with relevant demographic details. The only required fields are the professional's name and an associated ID. _Note:_ when enrolling a business, it is required to use the full name option in the name object.

Get Professional By ID GET

Retrieve a professional's demographic details. Get a professional using the `professionalId` as the unique identifier.