List all plans

get

https://api.advancehq.com/v1/plans

Lists plans with one status — open plans unless you pass another status. Use pagination=true for paginated results with metadata.

Query Params

pagination

boolean

Defaults to false

Enable pagination with metadata

page

integer

≥ 1

Defaults to 1

Page number (1-based) - only used when pagination=true

page_size

integer

1 to 10000

Defaults to 100

Number of items per page - only used when pagination=true

status

string

enum

Defaults to open

Plan status to list; open when left out. overdue lists unpaid plans past their due date.

insured_id

string | null

Optional insured ID to filter plans by

reconciliation_status

string

enum

Filter plans by reconciliation state: 'unreconciled', 'partially_reconciled', 'reconciled', or 'overpaid'

Allowed:

sort_by

string

enum

Field to sort by

Allowed:

sort_order

string

enum

Defaults to desc

Sort order (asc or desc)

Allowed:

search_term

string | null

Search term to filter plans by invoice number, insured/producer name, or amount

Responses

Language

Credentials

Bearer

JWT

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful Response

400Bad Request - Invalid input parameters or malformed request body

401Unauthorized - Missing or invalid authentication credentials

403Forbidden - Insufficient permissions to access this resource

404Not Found - The requested resource does not exist

422Validation Error

429Too Many Requests - Rate limit exceeded

500Internal Server Error - An unexpected error occurred