Skip to main content
POST
List Policies

Authorizations

x-api-key
string
header
required

Body

application/json

POST body for /v1/policies/filter.

policies
PolicyFilter · object | null

Policy filters. All fields optional; fields are AND'd together, and within a list field multiple values are OR'd. code_refs.match selects OR ('any', default) vs AND ('all') across refs.

sort
enum<string>
default:relevance

Sort order. Defaults to relevance: ranked against q when given, otherwise against the descriptions of the filtered codes; with neither, policy-id order.

Available options:
policy_id_asc,
policy_id_desc,
title_asc,
title_desc,
policy_number_asc,
policy_number_desc,
relevance
Example:

"relevance"

limit
integer
default:20

Maximum number of results to return

Required range: 1 <= x <= 100
Example:

20

offset
integer
default:0

Number of results to skip for pagination

Required range: x >= 0
Example:

0

include_applicability
boolean
default:false

Include each policy's payer/LOB/geography applicability. Returns current applicability by default, or — when a policies.effective_date window is given — the applicability in effect during that window.

Example:

true

include_code_groups
boolean
default:false

Include code groups (grouped by code system, relationship, and category)

Example:

true

Response

Successful Response

data
PolicyResult · object[]
required

Array of result objects

limit
integer
required

Maximum number of results requested

Example:

20

offset
integer
required

Number of results skipped for pagination

Example:

0

has_more
boolean
required

True if more results exist beyond this page

Example:

false