List Enrollments
Lists transaction enrollment records with optional filtering and pagination.
/enrollments
This is a beta endpoint. We may make backwards incompatible changes.
This endpoint retrieves a list of all transaction enrollments in your Stedi account.
You can filter the results by various criteria, such as a query string (fuzzy matching is supported), enrollment status, creation date, provider names, provider NPIs, provider tax IDs, and Stedi payer IDs. When a query parameter is an array, you can include it more than once in the URL to filter by multiple values.
Query parameters | Endpoint returns |
---|---|
?providerNames=John%20Doe&providerNames=Jane%20Doe | Enrollments associated with either John Doe or Jane Doe. |
?status=LIVE | Enrollments in LIVE status. |
?filter=OS&createdFrom=2025-01-01T00:00:00Z |
|
A Stedi API Key for authentication.
Query Parameters
The maximum number of elements to return in a page. If not specified, the default is 100.
- Range:
≥ 1 and ≤ 500
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 for enrollments with properties matching a query string. You can provide all or part of a provider name, NPI, or tax ID. You can also provide all or part of a payer's Stedi payer ID - primary payer IDs and aliases aren't supported. The search is case-insensitive and supports fuzzy matching.
For example, providing ?filter=OS
returns enrollments with provider.name
containing os
or OS
(such as Joseph
) and Stedi payer IDs containing OS
, such as OSBLI
for OptumHealth Salt Lake County.
Filter for enrollments with specific statuses. You can include this parameter multiple times to filter for multiple statuses.
For example, ?status=LIVE&status=REJECTED
returns enrollments that are in either LIVE
or REJECTED
status.
DRAFT
SUBMITTED
PROVISIONING
LIVE
REJECTED
Filter for enrollments associated with specific provider NPIs. You can include this parameter multiple times to filter for multiple NPIs.
For example, ?providerNpis=1234567890&providerNpis=0987654321
returns enrollments associated with either of the specified NPIs.
Filter for enrollments associated with specific provider tax IDs. You can include this parameter multiple times to filter for multiple tax IDs.
For example, ?providerTaxIds=123456789&providerTaxIds=987654321
returns enrollments associated with either of the specified tax IDs.
Filter for enrollments associated with specific provider names. You can include this parameter multiple times to filter for multiple names.
For example, ?providerNames=John%20Doe&providerNames=Jane%20Doe
returns enrollments associated with either John Doe or Jane Doe.
This search is case-sensitive and doesn't support fuzzy matching. The name you provide must match the provider's name exactly, including spaces and capitalization.
Filter for enrollments associated with specific Stedi payer IDs. You can include this parameter multiple times to filter for multiple payer IDs.
For example, ?payerIds=HGJLR&payerIds=EWDCI
returns enrollments associated with either of the specified payer IDs.
This parameter only supports Stedi payer IDs, not primary payer IDs or aliases. It also doesn't support fuzzy matching. The payer ID you provide must match the Stedi payer ID exactly, including capitalization.
Filter for enrollments submitted through specific sources, such as the API or UI. You can include this parameter multiple times to filter for multiple sources.
For example, ?sources=API&sources=UI
returns enrollments submitted through either of the specified sources.
API
UI
IMPORT
Filter for enrollments for specific transaction types. You can include this parameter multiple times to filter for multiple types.
For example, ?transactions=eligibilityCheck&transactions=claimStatus
returns enrollments for both 270/271 eligibility checks and 276/277 real-time claim status.
claimStatus
eligibilityCheck
institutionalClaimSubmission
professionalClaimSubmission
dentalClaimSubmission
Filter for enrollments created from a specific date.
For example, if you set this to 2025-01-01T00:00:00Z
, Stedi returns enrollments with a createdAt
timestamp on or after this date.
- Format:
date-time
Filter for enrollments created before a specific date.
For example, if you set this to 2025-01-01T00:00:00Z
, Stedi only returns enrollments with a createdAt
timestamp before this date.
The time must be later than createdFrom
, if present.
- Format:
date-time
Filter for enrollments whose status was last updated from a specific date.
For example, if you set this to 2025-01-01T00:00:00Z
, Stedi returns enrollments with a statusLastUpdatedAt
timestamp on or after this date.
- Format:
date-time
Filter for enrollments whose status was last updated before a specific date.
For example, if you set this to 2025-01-01T00:00:00Z
, Stedi only returns enrollments with a statusLastUpdatedAt
before this date.
The time must be later than statusUpdatedFrom
, if present.
- Format:
date-time
The import ID associated with an enrollment through a CSV bulk import. This ID is only available for enrollments created through the CSV import process.
Response
ListEnrollments 200 response
Token for pagination to retrieve the next page of results; null if there are no more results
- Required string length:
1 - 1024
Details about the enrollments matching the search criteria.
curl --request GET \ --url "https://enrollments.us.stedi.com/2024-09-01/enrollments" \ --header "Authorization: <api_key>"
fetch("https://enrollments.us.stedi.com/2024-09-01/enrollments", { headers: { "Authorization": "<api_key>" }})
package mainimport ( "fmt" "net/http" "io/ioutil")func main() { url := "https://enrollments.us.stedi.com/2024-09-01/enrollments" 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))}
import requestsurl = "https://enrollments.us.stedi.com/2024-09-01/enrollments"response = requests.request("GET", url, headers = { "Authorization": "<api_key>"})print(response.text)
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/enrollments")) .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();}
{
"message": "string",
"fieldList": [
{
"path": "string",
"message": "string"
}
]
}
{
"message": "string",
"code": "string"
}
{
"message": "string",
"code": "string"
}
{
"message": "string",
"code": "string"
}