latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Group

List groups matching filter criteria

Returns a paginated list of groups for the requesting tenant that match all supplied filter criteria (filters are combined with AND semantics); all filters are optional, and omitting them returns every group for the tenant. Use this endpoint to enumerate or search across groups; for a known certifyGroupId use GET /groups/{id}, and for autocomplete-style name/NPI/TIN prefix search use GET /groups/search. Pagination is offset-based via page and size; the default page size is 2 and no maximum page size is enforced.

get/groups

Query parameters

affiliationstring

Filters by case-insensitive substring match on the group's affiliation. Free text; not validated against an enum.

locationNamestring

Search by associated location name (partial, case-insensitive)

locationNpistring

Search by associated location NPI (exact 10-digit match)

namestring

Filters by case-insensitive substring match on the group's name.

npistring

Filters by exact, case-sensitive match on the group's NPI.

pageinteger

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

sizeinteger

Number of items per page in offset-based pagination. Defaults to 2 if not specified. No maximum page size is enforced.

tinstring

Filters by exact, case-sensitive match on the group's TIN.

typestring

Filters by exact, case-sensitive match on the group's type. Free text; not validated against an enum.

Headers

tenant-idstring

Response

Paginated envelope of group records matching the supplied filters

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"
  ]
}