v1

latestOpenAPI 3.1.02026-08-063776831.4 MB
Practitioner

Find Practitioner by filter criteria with pagination

Returns a paginated list of Practitioner based on filter criteria. Supports offset-based (page/size) pagination. Multiple filters are combined with AND logic.

get/practitioners

Query parameters

caqhProviderIdstring

Search by Caqh Provider Id

delegationStatusstring

Filter by delegation status (Direct or Delegated)

externalIdstring

Search by External Id

filterstring

Filter criteria as JSON (must be URL encoded). Multiple filters are combined with AND logic.

Filterable Fields:

  • credentialingStatus (String): Workflow status (eq, neq, in, nin, contains)
  • data.lineOfBusiness (Array): Line of business values (in, nin)
  • data.userDefinedFields.* (Any): User-defined fields with dot notation (eq, neq, in, nin, contains)
  • data.* (Any): Any data field (eq, neq, in, nin, contains, gt, gte, lt, lte)

Operations:

  • String: eq, neq, in, nin, contains
  • Array: in, nin (use in for arrays, not eq)
  • Numeric/Date: eq, neq, gt, gte, lt, lte

Examples:

{"credentialingStatus":{"eq":"PSV_READY"}}
{"credentialingStatus":{"in":["PSV_READY","PSV_COMPLETED"]}}
{"data.lineOfBusiness":{"in":["MEDICARE","MEDICAID"]}}
{"data.userDefinedFields.market":{"in":["MARKET1","MARKET2"]}}
{"credentialingStatus":{"eq":"PSV_READY"},"data.lineOfBusiness":{"in":["MEDICARE"]}}

Notes:

  • Filter must be URL encoded when sent as query parameter
  • tenantId from header always takes precedence (cannot be overridden)
  • Credentialing status derived from latest workflow timeline event
  • String operations are case-sensitive
firstNamestring

Search by Practitioner First Name

lastNamestring

Search by Practitioner Last Name

licensedStatesstring

Filter by licensed states (comma-separated list of state codes)

npistring

Search by NPI. May contain one or more values for bulk search (copy-paste): separate with comma, newline, tab, semicolon, or space. When one or more NPI values are provided via this parameter, the response includes optional identifiersSearched, matchedCount, notFoundCount, unmatchedIdentifiers. When the query parameter is omitted (standard list request), those fields are null.

pageinteger

Page number for offset-based pagination (0-based index). Defaults to 0 if not specified.

practitionerRolesstring

Search by Practitioner Roles (comma-separated list)

practitionerTypestring

Search by Practitioner Type (comma-separated list)

sizeinteger

Number of items per page in offset-based pagination. Defaults to 2 if not specified.

statesToCredentialstring

Filter by states to credential (comma-separated list of state codes)

Headers

X-PII-Viewstring

Include PII in response; requires practitioner read:pii permission

tenant-idstring

Response

List of Practitioner

totalCountinteger