List Providers

Lists providers with optional filtering and pagination.

GET /providers

This is a beta endpoint. We may make backwards incompatible changes.

This endpoint retrieves all of the provider records in your Stedi account. You can filter the results by the provider's name, NPI, or tax ID.

This endpoint returns only the provider record; it doesn't include information about associated transaction enrollments. To retrieve enrollment information, use the List Enrollments endpoint.

Authorizations

Authorization · string · required · header

A Stedi API Key for authentication.

Query Parameters

pageSize · number

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

• Range: ≥ 1 and ≤ 500

pageToken · string

An opaque token returned by a previous call to this endpoint in the nextPageToken property. You can use it to request the next page of results. If not specified, Stedi returns the first page of results.

• Required string length: 1 - 1024

filter · string

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).

Response

application/json

ListProviders 200 response

nextPageToken · string

Token for pagination to retrieve the next page of results; null if there are no more results

• Required string length: 1 - 1024

items · array<object>

Details about every provider your organization has created within Stedi.

items[]. id · string · required

A unique identifier Stedi assigns to this provider internally.

items[]. name · string · required

The provider's business name. This is typically the provider's practice name, such as Dental Associates, LLC, but it can also be the provider's first and last name.

items[]. npi · string · required

The provider's National Provider Identifier (NPI). This is a 10-digit number that is unique to the provider.

items[]. taxIdType · string · required

The type of tax ID. Can be either an EIN - Employer Identification Number, or an SSN - Social Security Number.

Possible values

EIN

SSN

items[]. taxId · string · required

The provider's tax ID, as specified by taxIdType. This identifier is formatted without any separators, such as dashes or spaces. For example 111-22-3333 is represented as 111223333.

cURL

curl --request GET \
  --url "https://enrollments.us.stedi.com/2024-09-01/providers" \
  --header "Authorization: <api_key>"

JavaScript

fetch("https://enrollments.us.stedi.com/2024-09-01/providers", {
  headers: {
    "Authorization": "<api_key>"
  }
})

Go

package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
)

func main() {
  url := "https://enrollments.us.stedi.com/2024-09-01/providers"

  req, _ := http.NewRequest("GET", url, nil)
  req.Header.Add("Authorization", "<api_key>")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}

Python

import requests

url = "https://enrollments.us.stedi.com/2024-09-01/providers"

response = requests.request("GET", url, headers = {
  "Authorization": "<api_key>"
})

print(response.text)

Java

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.net.http.HttpResponse.BodyHandlers;
import java.time.Duration;

HttpClient client = HttpClient.newBuilder()
  .connectTimeout(Duration.ofSeconds(10))
  .build();

HttpRequest.Builder requestBuilder = HttpRequest.newBuilder()
  .uri(URI.create("https://enrollments.us.stedi.com/2024-09-01/providers"))
  .header("Authorization", "<api_key>")
  .GET()
  .build();

try {
  HttpResponse<String> response = client.send(requestBuilder.build(), BodyHandlers.ofString());
  System.out.println("Status code: " + response.statusCode());
  System.out.println("Response body: " + response.body());
} catch (Exception e) {
  e.printStackTrace();
}

200

{
  "items": [
    {
      "id": "10334e76-f073-4b5d-8984-81d8e5107857",
      "name": "BDQ Dental Inc",
      "npi": "1999999992",
      "taxIdType": "EIN",
      "taxId": "555123456"
    },
    {
      "id": "10234e76-f067-4b5d-8984-81d8e5107123",
      "name": "Example Medical Associates",
      "npi": "1999999984",
      "taxIdType": "EIN",
      "taxId": "100100111"
    }
  ]
}

400

{
  "message": "string",
  "fieldList": [
    {
      "path": "string",
      "message": "string"
    }
  ]
}

401

{
  "message": "string",
  "code": "string"
}

403

{
  "message": "string",
  "code": "string"
}

500

{
  "message": "string",
  "code": "string"
}