Skip to the page
Chapters

Events

List events

GET/api/v1/events

The events of the key's organization in the key's mode, newest first. An event says that something happened (an eligibility check finished, an API key was created or revoked) and carries facts about it, never a patient's name, date of birth or member ID: read the resource by its ID for those. Filter by type, by the resource an event is about, or by creation time.

Needs a key with read permission.

Request

Query parameters

Query parameters
NameTypeRequiredDescription
limitintegeroptionalHow many items to return, from 1 to 100. Default 25.At least 1.At most 100.
cursorstringoptionalThe next_cursor of the previous page, to get the page after it. Opaque: pass it back unchanged.
typestringoptionalOnly events of this type.One of: `eligibility.completed`, `api_key.created`, `api_key.revoked`, `claim.validated`, `claim.needs_attention`, `claim.queued`, `claim.submitted`, `claim.accepted`, `claim.rejected`, `claim.status_updated`, `claim.voided`, `batch.acknowledged`, `attachment.completed`, `payer_request.received`, `era.received`, `claim.paid`, `claim.denied`, `claim.payment_reversed`, `predetermination.returned`.
resource_idstringoptionalOnly events about this resource: an eligibility check (elg_...) or an API key (key_...).
created_afterstring (date-time)optionalOnly events created after this instant (ISO 8601 with an offset, such as 2026-10-01T00:00:00Z).

Response

A page of events. Status 200.

Response fields
NameTypeDescription
dataarray of value
next_cursorvaluePass as cursor to get the next page; null when there is no next page.

Errors

Errors
HTTP statusCodeWhat it means
401UNAUTHORIZEDA valid API key is required. Send it as "Authorization: Bearer <key>".
403PERMISSION_DENIEDThis API key is not allowed to do that.
422INVALID_REQUESTThe request is not valid.
504TIMEOUTThe 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).
500INTERNALSomething went wrong on our side. Quote the request ID if you contact us.

Example

Example request

Shell
curl "https://sandbox.myclaimhouse.com/api/v1/events?type=eligibility.completed&limit=10" \
  -H "Authorization: Bearer $CLAIMHOUSE_KEY"

Example response: 200

JSON
{
  "data": [
    {
      "id": "evt_01JM000000E008000000000020",
      "object": "event",
      "type": "eligibility.completed",
      "sequence": 1,
      "created_at": "2026-03-10T15:30:00.430000+00:00",
      "data": {
        "id": "elg_01JM000000E00800000000000G",
        "object": "eligibility_check",
        "office_id": "off_01JM000000E008000000000003",
        "payer": {
          "id": "pyr_01JM000000E008000000000004",
          "payer_id": "00000",
          "name": "Example Dental Plan"
        },
        "state": "completed",
        "outcome": "answered",
        "status": "active",
        "billing": {
          "charged": false,
          "state": "not_billable",
          "reason": "test_mode",
          "label": "Not billed: test mode"
        },
        "cache": {
          "state": "fresh",
          "source_id": null
        },
        "parent_id": null,
        "request_id": "req_01JM000000E008000000000010",
        "tenant_reference": "visit-1042",
        "created_at": "2026-03-10T15:30:00.250000+00:00",
        "completed_at": "2026-03-10T15:30:00.430000+00:00"
      }
    }
  ],
  "next_cursor": null
}