Plans

Request plans

Create a request to get plans. The field plan_ids can be used to filter the plans by id.If empty, all plans will be returned.Optionally, the fields updated_date_utc_from and updated_date_utc_to can be used to restrict results to plans whose warehouse record was last updated within the given half-open UTC window (>= from, < to). Both bounds must be sent together; sending only one returns 422.The search will be processed asynchronously, being able to fetch the result from the provided search ID.

post/plans/search

Request

Base URL
https://data-reporting-api.prod.feverup.com/v1
Auth
OAuth 2
Password
Token URL/v1/auth/token
TypeScript
https://skmtc.dev/feverup/apis/fever-reporting-api/docs/plans/search/post.ts
A function with typed inputs. Its response is checked against the schema.

Headers

user-id-to-impersonateinteger

User id from the user that you want to impersonate

Request body

plan_idsinteger[]

List of ids of the plans to filter by.

updated_date_utc_fromstring

UTC start date for the warehouse last-updated filter (inclusive). Filters rows whose underlying warehouse record changed at or after this instant. If hour and minute are not specified, 00:00 is added by default

updated_date_utc_tostring

UTC end date for the warehouse last-updated filter (exclusive). Filters rows whose underlying warehouse record changed strictly before this instant. If hour and minute are not specified, 00:00 is added by default

Example request

{
  "updated_date_utc_from": "2026-05-24 00:00",
  "updated_date_utc_to": "2026-05-25 00:00"
}

Response

Request was created successfully but is still running asynchronously.

messagestring required

Message about the search status

search_idstring uuid required

The search ID

Example response

{
  "message": "Asynchronous execution in progress. Use provided query id to perform query monitoring and management.",
  "search_id": "b59d4093-cbfc-4a1d-be5c-ba78d4ffbc64"
}

Changes

No recorded changes to this operation across all 1 revision of this API.