List providers

Returns a page of providers.

Request

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 If set, the items will be filtered on providers with the specified name or alias name.
credentialingStatus	Array of strings If set, the items will be filtered on providers with the specified credentialing status.
providerTypeId	string <uuid> If set, the items will be filtered on providers with the specified provider type.
npi	integer <int64> If set, the items will be filtered on providers with the specified npi number.
deactivated	boolean If set, the items will be filtered on providers with the specified deactivated status.
nextCredentialingDateOnOrAfter	string <date> If set, the items will be filtered on providers with the specified next credentialing date that is equal to or greater than the date specified.
nextCredentialingDateOnOrBefore	string <date> If set, the items will be filtered on providers with the specified next credentialing date that is equal to or less than the date specified.
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"

Responses

200

Success

400

Bad Request

401

Unauthorized

403

Forbidden

404

Not Found

500

Server Error

get/providers

Response samples

application/json

{"previousCursor": "string",
"nextCursor": "string",
"nextOffset": 0,
"pageSize": 0,
"count": 0,
"totalCount": 0,
"items": [{"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"firstName": "string",
"lastName": "string",
"dateOfBirth": "2019-08-24T14:15:22.0000000Z",
"ssn": "***",
"credentialingStatus": "string",
"credentialedDate": "2019-08-24T14:15:22.0000000Z",
"npi": 0,
"aliases": [{"id": "9b4c12e8-02c5-4107-a524-c02416d43079",
"firstName": "string",
"lastName": "string"
}
],
"addresses": [{"id": "e57c9ee4-807d-456a-bf32-623280064ca5",
"state": "AL",
"zipCode": "string",
"city": "string",
"addressLine1": "string",
"addressLine2": "string",
"type": "Unspecified"
}
],
"emails": [{"id": "1d46ecfe-5ce4-4b9c-aaba-3543e15d36d1",
"email": "string",
"type": "Unspecified"
}
],
"phone": "string",
"languages": ["string"
],
"recredentialedDates": ["2019-08-24T14:15:22.0000000Z"
],
"providerType": {"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string"
}
}
],
"sortedBy": "Id",
"sortDirection": "Asc",
"sort": {"Id": "Asc",
"FirstName": "Asc",
"LastName": "Asc",
"CredentialingStatus": "Desc"
}
}