List Project Offerings

Request

Gets a paginated list of Project Offerings for a specified project, which serve as containers for resource plans, budgets, and financial models.

Security

ApiKey

Path

project_idstring, (uuid)required

The ID of the Project, to which this Project Offering belongs.

Query

pageinteger, (int32)

The specific page of results requested.

page_sizeinteger, (int32)

The number of results in each page.

termsstring

external_idstring

Filter by external ID. For Parallax-managed integrations, use the format 'px_provider:id' (e.g., 'px_harvest:12345'). For custom integrations, use the string format appropriate for that integration.

curl -i -X GET \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/projects/{project_id}/offerings?page=0&page_size=0&terms=string&external_id=string' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

countinteger, (int64)

The number of results in the current page.

totalinteger, (int64)

The total number of results that fulfill the request.

pageinteger, (int64)

The current page of results being returned.

total_pagesinteger, (int64)

The total number of available pages that fulfill the request.

page_sizeinteger, (int64)

The number of results in each page returned.

resultsArray of objects(ProjectOffering)required

The array of result objects for the current page.

Response

{
  "count": 0,
  "total": 0,
  "page": 0,
  "total_pages": 0,
  "page_size": 0,
  "results": [
    { … }
  ]
}