List providers for the group

Returns a page of providers for the specified group or generated csv roster if rosterType parameter specified.

Request
path Parameters
groupId
required
string <uuid>

The unique identifier of the group to get providers for.

query Parameters
status
string

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

Enum: "None" "NeedsReview" "ExpiresSoon" "Expired" "Monitored" "NotMonitored" "NotFoundLicenses" "DisciplinaryActionLicenses" "UnableToVerifyLicenses"
providerName
string
credentialingStatus
Array of strings

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

providerTypeId
string <uuid>
npi
integer <int64>

If set, the items will be filtered on providers with the specified npi number.

deactivated
boolean
nextCredentialingDateOnOrAfter
string <date>
nextCredentialingDateOnOrBefore
string <date>
sortedBy
string

The property by which the returned data will be sorted.

Enum: "Id" "LastName" "FirstName" "CredentialingStatus" "CredentialedDate"
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"
rosterType
string

If set, csv report of specified type will be generated.

Enum: "Providers" "Licenses" "Deas" "LiabilityInsurances"
Responses
200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/groups/{groupId}/providers
Response samples
application/json
{
  • "previousCursor": "string",
  • "nextCursor": "string",
  • "nextOffset": 0,
  • "pageSize": 0,
  • "count": 0,
  • "totalCount": 0,
  • "items": [
    ],
  • "sortedBy": "Id",
  • "sortDirection": "Asc",
  • "sort": {
    }
}