STstedi

GET /providers

Changed on

Lists providers with optional filtering and pagination.

Request

  • Base URL
    https://enrollments.us.stedi.com/2024-09-01
  • URL
    https://enrollments.us.stedi.com/2024-09-01/providers
  • Auth
    API key in header Authorization

Query parameters

pageSizenumber

The maximum number of elements to return in a page. If not specified, the default is 100.

pageTokenstring

The nextPageToken value from a previous response. You can use this to get the next page of results. If not set, Stedi returns the first page of results.

filterstring

Filter for providers with properties matching a query string. You can provide all or part of a provider name, NPI, or tax ID. The search is case-insensitive and supports fuzzy matching.

For example, providing ?filter=OS returns providers with names containing os (such as Joseph).

providerNpisstring[]

Filter for providers with NPIs matching any value in this list.

providerTaxIdsstring[]

Filter for providers with tax IDs matching any value in this list.

sortBystring[]

Sort the results by up to three properties. By default, Stedi sorts results by creation time in descending order.

Supply a query string with each property appended using &. Each property must be provided in a property:direction format, where property is the name of the property to sort by and direction is the sort direction, either asc (ascending) or desc (descending).

  • Stedi adds the provider id as the final sort criterion to ensure deterministic results.
  • When you provide multiple properties, Stedi sorts by their order in the query string.

Supported properties: name, npi, taxId

  • name sorts case-insensitively.
  • Providers without a tax ID sort last in both directions.
  • Sorting by a very long name can return a validation error instead of the next page.

Examples:

  • Sort by name in ascending order: ?sortBy=name:asc
  • Sort by taxId and then by npi: ?sortBy=taxId:asc&sortBy=npi:asc

Response

ListProviders 200 response

nextPageTokenstring

Token that you can supply in subsequent requests to retrieve the next page of results. If not returned, there are no more results.

Changes

  • ae3e62610be0Revision changes
    • info

      added the required property // to the response with the status

    • info

      added the required property // to the response with the status

  • 5a90769ac413Revision changes
    • info

      added the new optional query request parameter sortBy