Payer requests

List payer requests

GET/api/v1/payer_requests

The payer requests of the key's organization in the key's mode, newest first: what payers asked for about claims they have. Filter by state or claim. In test mode, a claim with the member ID CH-SOLICITED gets one 1 minute after the payer accepts it. Needs a key with read.

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.
state	string	optional	Only open or answered requests.One of: `open`, `answered`.
claim_id	string	optional	Only the requests about this claim (clm_...).

Response

A page of payer requests. Status 200.

Response fields
Name	Type	Description
data	array of object
data[].id	string	An ID that starts with prq_.
data[].object	string	Always `payer_request`.
data[].state	string	One of: `open`, `answered`.
data[].source	string	network (it arrived through the network) or staff (recorded by hand, from a letter).One of: `network`, `staff`.
data[].claim_id	string or null	An ID that starts with clm_.
data[].payer	object
data[].payer.id	string	An ID that starts with pyr_.
data[].payer.payer_id	string	The payer's own payer ID.
data[].payer.name	string
data[].reference_number	string	The payer's reference number: the answering attachment carries it.
data[].requested	string	What the payer asks for, in its words.
data[].due_date	string (date) or null
data[].answering_attachment_id	string or null	An ID that starts with att_.
data[].answered_at	string (date-time) or null
data[].created_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/payer_requests?state=open" \
  -H "Authorization: Bearer $CLAIMHOUSE_KEY"

Example response: 200

JSON

{
  "data": [
    {
      "id": "prq_01JM000000E008000000000040",
      "object": "payer_request",
      "state": "open",
      "source": "network",
      "claim_id": "clm_01JM000000E00800000000002G",
      "payer": {
        "id": "pyr_01JM000000E008000000000004",
        "payer_id": "00000",
        "name": "Example Dental Plan"
      },
      "reference_number": "PRQ000001042",
      "requested": "A narrative of the treatment and a current periapical X-ray of the tooth treated.",
      "due_date": "2026-10-25",
      "answering_attachment_id": null,
      "answered_at": null,
      "created_at": "2026-09-25T21:02:30.000000+00:00"
    }
  ],
  "next_cursor": null
}