List provider licenses

Returns a page of provider licenses.

Request
query Parameters
providerName
string

If set, the items will be filtered on providers with the specified (first or last) name.

providerCredentialingStatus
Array of strings

If set, the items will be filtered on providers with the specified credentialing status.

licenseState
string

If set, the items will be filtered on licenses with the specified license state.

Enum: "AL" "AK" "AZ" "AR" "CA" "CO" "CT" "DE" "DC" "FL" "GA" "HI" "ID" "IL" "IN" "IA" "KS" "KY" "LA" "ME" "MD" "MA" "MI" "MN" "MS" "MO" "MT" "NE" "NV" "NH" "NJ" "NM" "NY" "NC" "ND" "OH" "OK" "OR" "PA" "RI" "SC" "SD" "TN" "TX" "UT" "VT" "VA" "WA" "WV" "WI" "WY" "AS" "GU" "MP" "PR" "VI"
licenseType
string <uuid>

If set, the items will be filtered on licenses with the specified license type.

licenseStatus
string

If set, the items will be filtered on licenses with the specified license status.

Enum: "None" "Active" "Expired" "ExpiresSoon" "DisciplinaryActions" "Found" "NotFound" "UnableToVerify" "NeedsReview" "All"
licenseVerificationStatus
string

If set, the items will be filtered on licenses with the verification status.

Enum: "Verified" "Unverified"
licenseApprovedStatus
Array of strings
Items Enum: "Pending" "Yes" "No"
export
string
Enum: "None" "Csv"
providerDeactivated
boolean
sortedBy
string

The property by which the returned data will be sorted.

Enum: "ProviderFirstName" "ProviderLastName" "LicenseState" "LicenseExpirationDate"
object

If set, the properties and directions the returned data will be sorted by.

offset
integer <int32>
Deprecated

The offset for the page to start.

cursor
string

The cursor to render the page requested. To load the first page send an empty cursor, then the system will generate the cursors to go to the next and/or previous pages automatically.

count
integer <int32>

The number of items to include in a single page.

sortDirection
string

The direction the returned data will be sorted by.

Enum: "Asc" "Desc"
Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/provider-licenses
Response samples
application/json
{
  • "previousCursor": "string",
  • "nextCursor": "string",
  • "nextOffset": 0,
  • "pageSize": 0,
  • "count": 0,
  • "totalCount": 0,
  • "items": [
    ],
  • "sortedBy": "ProviderFirstName",
  • "sortDirection": "Asc",
  • "sort": {
    }
}