Skip to main content
GET
List and poll claims

Authorizations

Authorization
string
header
required

Send your API key as a bearer token: Authorization: Bearer osa_live_…. Keys are opaque; each belongs to exactly one firm and one purpose. Keys starting with osa_test_ reach only test claims and test accounts. The scopes listed on each operation are the permissions the key needs; GET /v1/me shows the ones your key has.

Query Parameters

updated_since
string<date-time>

Return only claims whose updated_at is at or after this time (inclusive). For polling, use the latest updated_at you have processed minus about one minute, and de-duplicate by id.

assignment_status
enum<string>

Return only claims whose assignment.status has this value. Where the latest offer stands. pending_acceptance: the adjuster hasn't answered yet. accepted: the adjuster accepted the claim. rejected: the adjuster rejected it; you can offer it to another adjuster. unassigned: the claim isn't currently offered to anyone; you can offer it to an adjuster.

Available options:
pending_acceptance,
accepted,
rejected,
unassigned
Example:

"pending_acceptance"

external_id
string

Return the claim with this external_id (your own claim id). Lookups only ever search your own firm, in the key's environment.

Your own id for the claim in your system (for example your claims-management record id). Unique within your firm and the key's environment (test or live), and never changed. No leading or trailing whitespace.

Required string length: 1 - 100
Pattern: ^\S(.*\S)?$
Example:

"CMS-884512"

limit
integer
default:50

Page size. Defaults to 50; at most 200.

Required range: 1 <= x <= 200
cursor
string

The next_cursor from the previous page. Cursors are opaque; send the same filters with each cursor as with the first page.

Required string length: 1 - 512

Response

One page of claims. next_cursor is null on the last page.

One page of claims.

data
object[]
required

The claims on this page, ordered by updated_at, then id.

next_cursor
string | null
required

Pass this as cursor to get the next page; null on the last page.