API Reference

List Budget Contracts

get
https://api.scalepad.com/lifecycle-manager/v1/budget//contracts

List a client's contracts with per-period forecast amounts, sorted and paginated.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The unique Core identifier of the client.

Query Params
string
enum

Reporting cadence.

Allowed:
int32
1 to 12

Number of periods to include; integer between 1 and 12 inclusive.

date-time

Anchor date-time for the first period. Use midnight UTC when calling with a calendar-day anchor.

boolean

Include items whose status is overdue. Defaults to true.

boolean

Include items whose status is not scheduled. Defaults to true.

string
^(eq):.+$

Third-party contract flag filter using the "eq:" operator, e.g. eq:true.

string
^(cont|eq):.+$

Contract-name filter using the "cont:" or "eq:" operator.

string
^[+-]?[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*(,[+-]?[a-z][a-z0-9_]*(\.[a-z][a-z0-9_]*)*)*$

One or more sortable fields, separated by commas. Prefix with '+' to sort ascending or '-' to sort descending.

int32

The number of records to be returned in a single page

string

Opaque cursor of the page to return. Omit this value for the first
page, then pass the next_cursor value from the previous response.

  • Cursor pagination cannot guarantee atomicity.
  • Endpoints may skip new records inserted between paginated reads.
  • Endpoints may occasionally return duplicate records.
Responses

Updated 3 months ago

Did this page help you?
Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago

Did this page help you?