Skip to main content
GET
List recurrence plans

Headers

x-api-key
string
required
Example:

"your-x-api-key"

x-api-token
string
required
Example:

"your-x-api-token"

Query Parameters

title
string

Filter by plan title.

enabled
boolean

Filter by plan status (active/inactive).

frequency
string

Filter by frequency.

page
integer
default:0

Page number for the query.

maxPageResults
integer
default:20

Maximum number of results per page.

Response

List of plans returned successfully.

status
integer
Example:

0

message
string
Example:

"success"

totalElements
integer

Total number of plans found.

Example:

1

totalPages
integer

Total number of pages.

Example:

1

resultSize
integer

Number of plans returned in the current page.

Example:

1

result
object[]