Enrollments

List enrollments

GET/api/v1/enrollments

The enrollments of the key's organization in the key's mode, newest first, one page at a time. Filter by provider, payer, type or status. The method comes from the payer directory's enrollment code for the type when the enrollment is started; a payer that needs no enrollment for it starts active. A claim to a payer that needs claims enrollment, for a provider with no active claims enrollment there, gets the ENROLLMENT_NOT_ACTIVE warning (it never blocks).

Needs a key with read permission.

Request

Query parameters

Query parameters
Name	Type	Required	Description
limit	integer	optional	How many items to return, from 1 to 100. Default 25.At least 1.At most 100.
cursor	string	optional	The next_cursor of the previous page, to get the page after it. Opaque: pass it back unchanged.
provider_id	string	optional	Only the enrollments of this provider (prv_...).
payer_id	string	optional	Only the enrollments with this payer (pyr_...).
type	string	optional	Only enrollments of this type.One of: `claims`, `era`, `era_eft`.
status	string	optional	Only enrollments in this status.One of: `not_started`, `awaiting_signature`, `provider_action`, `submitted`, `active`.

Response

A page of enrollments. Status 200.

Response fields
Name	Type	Description
data	array of object
data[].id	string	An ID that starts with enr_.
data[].object	string	Always `enrollment`.
data[].provider_id	string	An ID that starts with prv_.
data[].provider_name	string
data[].payer_id	string	An ID that starts with pyr_.
data[].payer_name	string
data[].type	string	One of: `claims`, `era`, `era_eft`.
data[].method	object or null	How the payer enrolls a provider, from the payer directory; null when the payer needs no enrollment for this (it started active).
data[].method.code	string	The payer directory's enrollment code when the enrollment was started (S, O, W, F, I or U, with * or L).
data[].method.label	string
data[].method.instructions	string	What has to be done, in plain words.
data[].status	string	One of: `not_started`, `awaiting_signature`, `provider_action`, `submitted`, `active`.
data[].next_step	string	What someone has to do now, in plain words.
data[].sent_on	string (date) or null
data[].expected_on	string (date) or null
data[].note	string
data[].mode	string	One of: `test`, `live`.
data[].activated_at	string (date-time) or null	When it last became active; null while it is not.
data[].created_at	string (date-time)
data[].updated_at	string (date-time)
next_cursor	value	Pass as cursor to get the next page; null when there is no next page.

Errors

Errors
HTTP status	Code	What it means
401	UNAUTHORIZED	A valid API key is required. Send it as "Authorization: Bearer <key>".
403	PERMISSION_DENIED	This API key is not allowed to do that.
422	INVALID_REQUEST	The request is not valid.
504	TIMEOUT	The request took too long to finish. It may still have taken effect: look it up before sending it again with a new Idempotency-Key. What it made is found with GET /api/v1/eligibility?request_id=<this request_id>, and the same filter on /api/v1/claims and /api/v1/attachments (a key with read permission).
500	INTERNAL	Something went wrong on our side. Quote the request ID if you contact us.

Example

Example request

Shell

curl "https://sandbox.myclaimhouse.com/api/v1/enrollments?status=not_started&limit=25" \
  -H "Authorization: Bearer $CLAIMHOUSE_KEY"

Example response: 200

JSON

{
  "data": [
    {
      "id": "enr_01JM000000E00800000000004M",
      "object": "enrollment",
      "provider_id": "prv_01JM000000E008000000000005",
      "provider_name": "Dr. Riley Example, DDS",
      "payer_id": "pyr_01JM000000E008000000000004",
      "payer_name": "Example Dental Plan",
      "type": "claims",
      "method": {
        "code": "W",
        "label": "Payer paperwork (fax or email)",
        "instructions": "The payer requires its own enrollment paperwork. Claim House supplies a copy, and the provider returns it by fax, email or mail so Claim House can submit it to the payer."
      },
      "status": "not_started",
      "next_step": "Start the paperwork.",
      "sent_on": null,
      "expected_on": null,
      "note": "",
      "mode": "test",
      "activated_at": null,
      "created_at": "2026-09-20T15:00:00+00:00",
      "updated_at": "2026-09-20T15:00:00+00:00"
    }
  ],
  "next_cursor": null
}