List Agreement Items

get

https://api.scalepad.com/lifecycle-manager/v1/agreement-items

List Lifecycle Manager agreement items with source pricing and product linkage fields.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

filter[agreement.id]

string

^(eq):.+$

Limits results to items for an agreement id.

filter[client.id]

string

^(eq):.+$

Limits results to items for a Lifecycle Manager client id.

filter[product.id]

string

^(eq):.+$

Limits results to items linked to a public product id.

filter[status]

string

^(eq|in):.+$

Limits results by source agreement item status.

filter[price_type]

string

^(eq):.+$

Limits results by Lifecycle Manager price type.

filter[is_billable]

string

^(eq):.+$

Limits results by effective billable status across the agreement header and item.

sort

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.

page_size

int32

The number of records to be returned in a single page

cursor

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

Language

Credentials

Header

Loading…

Response

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

application/json

200OK

400Bad Request

402Payment Required

403Forbidden

404Not Found

422Unprocessable Content