Sign in

Exports enrollment records as a CSV file with optional filtering. Supports the same filtering parameters as ListEnrollments operation. Returns a presigned URL to download the generated CSV file from S3.

post/enrollments/export

Request body

createdFromstring date-time

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.

createdTostring date-time

Filter for enrollments created before a specific date. The time must be later than createdFrom, if present.

For example, if you set this to 2025-01-01T00:00:00Z, Stedi only returns enrollments with a createdAt timestamp before this date.

filterstring

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.

importIdstring

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.

lastEraReceivedFromstring date-time

Filter for enrollments with a lastEraReceivedAt timestamp on or after this value. Only enrollments with an ERA are included.

You can use this filter with lastEraReceivedTo to define a date range. For example, setting this to 2025-01-01T00:00:00Z returns enrollments with a lastEraReceivedAt on or after that date.

lastEraReceivedTostring date-time

Filter for enrollments with a lastEraReceivedAt timestamp on or before this value. Only enrollments with an ERA are included. This value must be later than lastEraReceivedFrom, if present.

For example, setting this to 2025-01-01T00:00:00Z returns enrollments with a lastEraReceivedAt on or before that date.

payerIdsstring[]

Filter for enrollments associated with specific Stedi 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. You must include leading 0 characters - for example, use 00540 for SISCO, not 540.

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.

providerIdsstring[]

Filter for enrollments associated with specific provider IDs.

The provider ID is a UUID Stedi assigns to each provider record upon creation, allowing you to differentiate between provider records that share the same NPI. It's returned in the id property of the Create Provider and Retrieve Provider responses.

You can include this parameter multiple times to filter for multiple providers. For example, ?providerIds=10334e76-f073-4b5d-8984-81d8e5107857&providerIds=10234e76-f067-4b5d-8984-81d8e5107123 returns enrollments associated with either of the specified providers.

providerNamesstring[]

Filter for enrollments associated with specific provider names.

This search is case-insensitive but doesn't support fuzzy matching. The name you provide must match the provider's name exactly, including spaces, but capitalization is ignored.

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.

providerNpisstring[]

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.

providerTaxIdsstring[]

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.

requestedEffectiveDateFromstring

Filter for enrollments with a requested effective date on or after this date, in YYYYMMDD format.

For example, ?requestedEffectiveDateFrom=20260101 returns enrollments with a requestedEffectiveDate of 20260101 or later.

requestedEffectiveDateTostring

Filter for enrollments with a requested effective date on or before this date, in YYYYMMDD format. The date must be the same as or later than requestedEffectiveDateFrom, if present.

For example, ?requestedEffectiveDateTo=20261231 returns enrollments with a requestedEffectiveDate of 20261231 or earlier.

sourcesEnrollmentSource[]

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.

statusEnrollmentStatus[]

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.

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

statusUpdatedTostring date-time

Filter for enrollments whose status was last updated before a specific date. The time must be later than statusUpdatedFrom, if present.

For example, if you set this to 2025-01-01T00:00:00Z, Stedi only returns enrollments with a statusLastUpdatedAt before this date.

transactionsTransactionType[]

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.

userEmailsstring[]

Filter for enrollments associated with specific submitter emails. This is the userEmail property in Create Enrollment requests, or the Stedi contact person in the portal.

This search is case-insensitive but doesn't support fuzzy matching. The email you provide must match the submitter's email exactly, but capitalization is ignored.

You can include this parameter multiple times to filter for multiple submitter emails. For example, ?userEmails=alice%40example.com&userEmails=bob%40example.com returns enrollments submitted by either alice@example.com or bob@example.com.

Response

ExportEnrollmentsCsv 200 response

downloadUrlstring

A presigned URL for downloading the generated CSV file from S3. Undefined if no enrollments found.

filenamestring

The filename of the generated CSV file. Undefined if no enrollments found.

recordCountnumber required

The number of enrollment records exported to the CSV file. 0 if no enrollments found.

Changes

Changed in 6 of the 52 revisions of this API.10

  • b8c26fa9ea691See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • 1e51e62283c11See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

  • c3067683b3aa1See the full diff
    • ○

      added the new AUTOMATED_TASK enum value to the request property /

      request-property-enum-value-added

  • 53d33f7bccfd2See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property

  • 9f17ab96c9103See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

  • 20b983b38d332See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    • ○

      added the new optional request property

      new-optional-request-property