--- title: "GET /enrollments" method: GET path: "/enrollments" --- # GET /enrollments `GET /enrollments` Lists transaction enrollment records with optional filtering and pagination. ## Query parameters - `pageSize` number — The maximum number of elements to return in a page. If not specified, the default is 100. - `pageToken` string — 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. - `filter` string — 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](https://www.stedi.com/docs/healthcare/supported-payers#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. - `status` EnrollmentStatus[] — 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. - `providerNpis` string[] — 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. - `providerTaxIds` string[] — 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. - `providerNames` string[] — 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. - `providerIds` string[] — 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](/healthcare/api-reference/post-enrollment-create-provider#response.id) and [Retrieve Provider](/healthcare/api-reference/get-enrollment-provider#response.id) 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. - `payerIds` string[] — Filter for enrollments associated with specific [Stedi payer IDs](https://www.stedi.com/docs/healthcare/supported-payers#stedi-payer-id). 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. - `sources` EnrollmentSource[] — 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. - `transactions` TransactionType[] — 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. - `createdFrom` string, 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. - `createdTo` string, 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. - `statusUpdatedFrom` string, 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. - `statusUpdatedTo` string, 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. - `importId` string — 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. - `requestedEffectiveDateFrom` string — 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. - `requestedEffectiveDateTo` string — 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. - `lastEraReceivedFrom` string, 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. - `lastEraReceivedTo` string, 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. - `userEmails` string[] — Filter for enrollments associated with specific submitter emails. This is the `userEmail` property in [Create Enrollment](https://www.stedi.com/docs/healthcare/api-reference/post-enrollment-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`. - `sortBy` string[] — Sort the results by one or more properties. By default, Stedi sorts results by the `createdAt` property 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). - When you don't include `id`, Stedi automatically adds it as the final sort criterion to ensure deterministic results. - When you provide multiple properties, Stedi sorts by their order in the query string. For example, if you provide `?sortBy=updatedAt:desc&sortBy=id:asc`, Stedi sorts first by `updatedAt` in descending order. If multiple records share the same `updatedAt` date, Stedi then sorts those records by `id` in ascending order. **Supported properties:** `updatedAt`, `statusLastUpdatedAt`, `id`, `requestedEffectiveDate`, `lastEraReceivedAt` Examples: - Sort by `updatedAt` in descending order: `?sortBy=updatedAt:desc` - Sort by `statusLastUpdatedAt` in ascending order: `?sortBy=statusLastUpdatedAt:asc` - Sort by `updatedAt` and then by `id`: `?sortBy=updatedAt:desc&sortBy=id:asc` ## Response `200` ListEnrollments 200 response - ListEnrollmentsResponseContent — Output containing a paginated list of enrollments. - `items` EnrollmentSummary[] — Details about the enrollments matching the search criteria. - `aggregationPreference` union — Preference for how the payer should group 835 Electronic Remittance Advice (ERA) transactions. Only set this property for 835 ERA enrollments. - If you include this property for a non-ERA enrollment, Stedi rejects the enrollment request with an HTTP `400` error. - If the payer doesn't support the requested aggregation type, Stedi rejects the enrollment request with an HTTP `400` error. - If not set, Stedi automatically selects a default based on the payer's supported aggregation types and the available identifiers for the provider. - Stedi will attempt to enroll with this preference, but it's not guaranteed. Each payer has its own restrictions and behaviors. - object - `taxId` string, required — The Taxpayer Identification Number (TIN) the payer should use for aggregation. - object - `npi` string, required — The National Provider Identifier (NPI) the payer should use for aggregation. - `createdAt` string, date-time, required — The date and time when the enrollment was created within Stedi. - `documents` EnrollmentDocument[] — Documents associated with this enrollment, such as signed enrollment forms. This list doesn't include deleted documents. Each document object contains metadata such as the document's name, status, and timestamps for creation and last update. - `contentType` string — The content type of the document. - `createdAt` string, date-time, required — The date and time when the document was created. - `enrollmentId` string, required — The enrollment ID this document is associated with. - `id` string, required — The unique identifier for the document. - `name` string, required — The name of the document. - `size` number — The size of the document in bytes. - `status` 'PENDING' | 'UPLOADED' | 'FAILED' | 'DELETED', required — Indicates whether the document file has been successfully uploaded to Stedi. - `taskId` string — The task ID associated with this document, if it was created or processed as part of a task. - `updatedAt` string, date-time, required — The date and time when the document was last updated. - `history` EnrollmentHistoryEntry[] — The history of updates to this enrollment, such as status changes. This property is experimental and may change in the future. - `changedAt` string, date-time, required — The date and time when this change occurred. - `changedBy` string, required — The source or system that triggered this change. - `newStatus` 'DRAFT' | 'SUBMITTED' | 'PROVISIONING' | 'LIVE' | 'REJECTED' | 'CANCELED' | 'STEDI_ACTION_REQUIRED' | 'PROVIDER_ACTION_REQUIRED', required — The status of the enrollment. You can submit enrollments with either `DRAFT` or `STEDI_ACTION_REQUIRED` status - the default is `DRAFT` if not included. Set this to `STEDI_ACTION_REQUIRED` when you're ready for Stedi to begin processing the enrollment. Once an enrollment is `STEDI_ACTION_REQUIRED`, only Stedi can set or update its status. - `previousStatus` 'DRAFT' | 'SUBMITTED' | 'PROVISIONING' | 'LIVE' | 'REJECTED' | 'CANCELED' | 'STEDI_ACTION_REQUIRED' | 'PROVIDER_ACTION_REQUIRED' — The status of the enrollment. You can submit enrollments with either `DRAFT` or `STEDI_ACTION_REQUIRED` status - the default is `DRAFT` if not included. Set this to `STEDI_ACTION_REQUIRED` when you're ready for Stedi to begin processing the enrollment. Once an enrollment is `STEDI_ACTION_REQUIRED`, only Stedi can set or update its status. - `type` 'STATUS_CHANGE', required — The type of change recorded in the enrollment history. - `id` string, required — The Stedi-assigned identifier for the enrollment. - `importId` string — The import ID associated with the enrollment if it was created through a CSV bulk import (`source` is set to `IMPORT`). This property is only present for enrollments created through the CSV import process. - `lastEraReceivedAt` string, date-time — The timestamp of the most recent 835 ERA (Electronic Remittance Advice) Stedi received for this enrollment, based on the enrollment's payer ID, provider NPI, and provider tax ID. Stedi automatically updates this property for each new ERA. - This property is only returned for ERA enrollments in `LIVE` status with at least one matching ERA from the payer. - If this timestamp doesn't match your expected timeline for ERA processing, there may be an upstream issue. Contact Stedi support for assistance. - `payer` EnrolledPayerOutput, required — Output structure containing payer information in enrollment responses. - `name` string — The payer's name, such as `Cigna` or `UnitedHealthcare`. - `stediPayerId` string, required — The unique Stedi assigned identifier for the payer. - `submittedPayerIdOrAlias` string — The payer ID or alias used when creating the enrollment request. For example, `62308` and `CIGNA` are both supported for Cigna. You can find a list of all supported payer IDs and aliases in the [Payer Network](https://www.stedi.com/healthcare/network). - `provider` AllEnrolledProviderFields, required — Complete provider information including both read-only and mutable fields. - `id` string, required — The Stedi-assigned identifier for the provider. The [Create Provider](https://www.stedi.com/docs/api-reference/healthcare/post-enrollment-create-provider) endpoint returns this as the `id` property. - `name` string, required — The provider's name, such as `Example Dental Associates, LLC`. - `npi` string, required — The provider's National Provider Identifier (NPI). This is a 10-digit number assigned by the Centers for Medicare & Medicaid Services (CMS) to healthcare providers in the United States. It is used to identify providers in healthcare transactions. - `taxId` string, required — The provider's tax identification number (SSN or EIN). This is used to identify the provider for tax and administrative purposes. - `taxIdType` string, required — The type of tax identification number. This indicates whether the tax ID is a Social Security Number (SSN) or Employer Identification Number (EIN). - `reason` string — Reasons why the enrollment request is still in `PROVISIONING` status, may take additional time to process, or was rejected by the payer. Only Stedi can set or update this property. - `requestedEffectiveDate` string — The requested effective date for the enrollment in YYYYMMDD format. This is the date the submitter would like the enrollment to take effect with the payer. If not provided during submission, Stedi defaults to the enrollment's submission date. Not all payers support requested effective dates. Stedi can't guarantee that the enrollment will be effective with the payer on this exact date. - `source` 'API' | 'UI' | 'IMPORT' | 'AUTO_ENROLLMENT' | 'AUTOMATED_TASK', required — The source of the enrollment. - `status` 'DRAFT' | 'SUBMITTED' | 'PROVISIONING' | 'LIVE' | 'REJECTED' | 'CANCELED' | 'STEDI_ACTION_REQUIRED' | 'PROVIDER_ACTION_REQUIRED', required — The status of the enrollment. You can submit enrollments with either `DRAFT` or `STEDI_ACTION_REQUIRED` status - the default is `DRAFT` if not included. Set this to `STEDI_ACTION_REQUIRED` when you're ready for Stedi to begin processing the enrollment. Once an enrollment is `STEDI_ACTION_REQUIRED`, only Stedi can set or update its status. - `statusLastUpdatedAt` string, date-time, required — The date and time when the enrollment status was last updated. This timestamp is used to track enrollment processing durations and enables filtering to identify recently changed enrollments. It automatically updates whenever an enrollment's status changes but remains unchanged during other updates. - `submittedAt` string, date-time — The date and time when the enrollment was submitted. If the enrollment is in draft status, `submittedAt` is not present. When the enrollment transitions from draft to submitted, `submittedAt` will be updated to the submission time. If the enrollment was created and submitted immediately, `submittedAt` will be equal or close to `createdAt`. - `tasks` Task[] — Tasks associated with this enrollment, such as reminders or follow-ups. - `completedAt` string, date-time — The timestamp when the task was completed. - `definition` union, required — A discriminated union of task definitions. Supports multiple task types with future extensibility. - object - `followInstructions` FollowInstructionsTask, required — Follow-instructions task data containing text instructions for a user to follow. - `instructions` string, required — Human-readable instructions for the responsible party to follow. - object - `provideFilledPdf` ProvideFilledPdfTask, required — A task that requires uploading a PDF document. Stedi will either provide an enrollment template PDF to download and complete, or provide instructions for uploading supporting documentation, such as a W-9 form. - `documentDownloadUrl` string — The API URL for the [Download Enrollment Document](/healthcare/api-reference/get-enrollment-document-download) endpoint with the document ID prepopulated. For example: `https://enrollments.us.stedi.com/2024-09-01/documents/019375d0-9876-7890-abcd-567890fedcba/download`. When you make an authenticated `GET` request to this URL, Stedi returns a pre-signed URL that you can use to download the PDF template. This property is only present when Stedi provides a template to download. - `instructions` string, required — Instructions for the task. They describe what needs to be completed in a downloadable PDF template or what type of supporting documentation to upload. - object - `provideInformation` ProvideInformationTask, required — Task for collecting specific information from the provider. - `instructions` string, required — Instructions explaining how to provide the necessary information. - object - `manualTask` ManualTask, required — A task assigned to a responsible party that requires them to collect and submit a defined set of fields. The task is completed by supplying a `ManualTaskResponse` whose values satisfy the declared `fields`. - `fields` ManualTaskField[], required — Fields required to complete the task. Each entry defines the key, human-readable label, optional description, and type for values in the response. Can be empty for instruction-only tasks. - … - `instructions` string, required — Instructions for completing the task. - `links` TaskLink[] — Links to help complete the task. This can include payer portals, reference documentation, or document download links for Stedi-provided template PDFs. - … - `id` string, required — The unique, Stedi-assigned identifier for the task. - `isComplete` boolean, required — Whether the task has been marked as complete through either the API or the Stedi portal. - `rank` number, required — The rank order of this task. Tasks with lower numbers must be completed first. For example, a task with rank `1` must be completed before a task with rank `2`. - `responseData` union — A discriminated union of task response data. Contains structured data collected when completing specific task types. - object - `pdfUpload` PdfUploadResponse, required — Response data containing the uploaded PDF after completion. - `documentId` string, required — The document ID for the uploaded PDF, such as `019375d0-1234-7890-abcd-567890abcdef`. This ID is available in the response from the [Upload Enrollment Document](https://www.stedi.com/docs/healthcare/api-reference/post-enrollment-document-upload) endpoint. You can also retrieve it from the [Retrieve Enrollment](https://www.stedi.com/docs/healthcare/api-reference/get-enrollment) or [List Enrollments](https://www.stedi.com/docs/healthcare/api-reference/get-enrollment-list-enrollments) endpoints. - `fileName` string, required — The filename of the uploaded PDF, such as `completed-enrollment-form.pdf`. This should match the `name` you supplied when you called the [Upload Enrollment Document](https://www.stedi.com/docs/healthcare/api-reference/post-enrollment-document-upload) endpoint. - object - `provideInformation` ProvideInformationResponse, required — Response data for `ProvideInformation` task completion. - `response` string, required — Notes or confirmation text from the responsible party in response to completing a `ProvideInformation` task. - object - `manualTask` ManualTaskResponse, required — Values provided when updating or completing a manual task. Visit [Manage enrollment tasks](https://www.stedi.com/docs/healthcare/transaction-enrollment-tasks-documents#api) for details. - `values` ManualTaskResponseKeyValue[], required — Values for fields in the task definition. Each value's `key` must have a corresponding field `key`. When updating a task without completing it, you can submit a subset of fields; the supplied values are merged into any previously saved values. Completing a task (`completed: true`) requires a value for every field. - … - `responsibleParty` 'PROVIDER' | 'STEDI', required — The party responsible for completing a task. - `transactions` union, required — Specifies which transaction types are included in the enrollment. - object - `eligibilityCheck` EnrolledTransaction, required — Represents the enrollment status for a specific transaction type. - `enroll` boolean, required - object - `claimStatus` EnrolledTransaction, required — Represents the enrollment status for a specific transaction type. - `enroll` boolean, required - object - `professionalClaimSubmission` EnrolledTransaction, required — Represents the enrollment status for a specific transaction type. - `enroll` boolean, required - object - `institutionalClaimSubmission` EnrolledTransaction, required — Represents the enrollment status for a specific transaction type. - `enroll` boolean, required - object - `dentalClaimSubmission` EnrolledTransaction, required — Represents the enrollment status for a specific transaction type. - `enroll` boolean, required - object - `claimPayment` EnrolledTransaction, required — Represents the enrollment status for a specific transaction type. - `enroll` boolean, required - object - `solicitedClaimAttachment` EnrolledTransaction, required — Represents the enrollment status for a specific transaction type. - `enroll` boolean, required - object - `unsolicitedClaimAttachment` EnrolledTransaction, required — Represents the enrollment status for a specific transaction type. - `enroll` boolean, required - `updatedAt` string, date-time, required — The date and time when the enrollment was updated. - `nextPageToken` string — Token that you can supply in subsequent requests to retrieve the next page of results. If not returned, there are no more results. - `totalCount` number — The total count of enrollments matching the filter criteria, regardless of pagination. ## Other responses - `400` — ValidationException 400 response - `401` — UnauthorizedException 401 response - `403` — AccessDeniedException 403 response - `429` — QuotaExceededException 429 response - `500` — InternalFailureException 500 response - `503` — ServiceUnavailableException 503 response - `504` — GatewayTimeoutException 504 response --- [API](https://skmtc.net/stedi/apis/stedi-enrollment.md) · [All operations](https://skmtc.net/stedi/apis/stedi-enrollment/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/stedi/stedi-enrollment/versions/0a692cc4f303/schema)