Skip to main content
GET
Cross-type plan search

Authorizations

Authorization
string
header
required

User session token issued by NextAuth. For human users accessing Solya via the web application.

Query Parameters

page
integer
default:1

Page number, 1-indexed (default: 1)

Required range: 1 <= x <= 9007199254740991
pageSize
integer
default:20

Number of items per page, max 100 (default: 20)

Required range: 1 <= x <= 100
q
string
required

Case-insensitive substring searched against plan name and plan code (min 1 character)

Minimum string length: 1
type
status
string

Restrict results to plans with this exact status value (e.g. DRAFT, VALIDATED, CLOSED)

Response

Successful response

data
object[]
required

Page of items

meta
object
required

Pagination metadata

success
enum<boolean>
required
Available options:
true