Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Group

Search groups by name, NPI, or TIN

Returns a paginated list of groups whose name (substring), NPI (prefix), or TIN (prefix) matches the supplied query term. Results are suitable for use in autocomplete dropdowns where the user needs to disambiguate groups with similar names. The stored reference for a selected group is the 'id' field (certifyGroupId).

get/groups/search

Query parameters

pageinteger

Page number (0-based)

qstring required

Search term matched against group name (substring, case-insensitive), NPI (prefix), and TIN (prefix). Min 2 chars, max 128 chars.

sizeinteger

Page size (max 50)

Headers

tenant-idstring

Response

Paginated list of matching groups

totalCountinteger

Total number of records matching the request, across all pages.

identifiersSearchedinteger

Count of identifiers submitted for a bulk-identifier search (e.g. bulk NPI search). Omitted/null for standard (non-bulk) list requests.

matchedCountinteger

Count of submitted identifiers that matched a record. Omitted/null for standard (non-bulk) list requests.

notFoundCountinteger

Count of submitted identifiers that did not match any record. Omitted/null for standard (non-bulk) list requests.

unmatchedIdentifiersstring[]

Submitted identifiers that did not match any record. Omitted/null for standard (non-bulk) list requests.

Example response

{
  "totalCount": 1,
  "identifiersSearched": 2,
  "matchedCount": 1,
  "notFoundCount": 1,
  "unmatchedIdentifiers": [
    "9999999999"
  ]
}