Skip to content
/
UpdateProjectOffering

Parallax Api (v1)

Overview

Access to the Parallax API is available exclusively to Parallax API customers. To learn more about becoming a Parallax API customer, please reach out to your Customer Success Manager.

All Parallax API calls are made under https://api.getparallax.com and all responses return standard JSON. The following HTTP methods are supported:

  • GET
  • POST
  • PATCH
  • DELETE
Download OpenAPI description
swagger.json
swagger.yaml
Overview
License
Proprietary
Languages
Servers
Mock server
https://developer.getparallax.com/_mock/api-documentation/swagger/
Production Server
https://api.getparallax.com/

ActualTime

Actual Time represents the timesheet data capturing the work performed by employees and logged against assigned Project Offerings. Actual Time is used to compare planned vs. actual effort, drive utilization reporting, support variance analysis, and inform project health and forecasting across the platform.

Operations

Clients

A client represents the customer organization associated with one or more projects. Clients serve as the primary entity used to group projects, service offerings, and resource plans, allowing for aggregated reporting on revenue, margin, utilization, and forecasting. Each project is tied to a client, enabling organizations to track work and financial performance at both the individual project and client account levels.

Operations

Departments

A department is used to categorize and group roles within the organization based on functional teams or disciplines. Departments help segment resource capacity, manage utilization targets, and support filtering within reporting and planning workflows. Each role in Parallax belongs to a department for organizational clarity and capacity planning.

Operations

People

People represent the individual resources available for assignment to projects. People are assigned roles, billable capacity, and utilization targets, and can be categorized by worker type, billing type, and department. A Persons record is central to capacity planning, resource allocation, forecasting, and reporting across the platform.

Operations

Pipelines

A Pipeline mirrors the sales opportunity stages configured in the integrated CRM system. The Pipeline allows Parallax to track deal progression, forecast demand, and convert opportunities into projects once deals are closed-won.

Operations

ProjectOfferingRoles

A Project Offering Role defines the specific role, resource allocation, and scheduled hours needed within a Project Offering. These roles form the basis of the resource plan by identifying the skill sets, timelines, and capacity requirements for successful delivery of the scoped work.

Operations

ProjectOfferings

A Project Offering represents a distinct scope or phase of work within a Project. Each Project Offering contains resource plans, financial models, and revenue data, allowing organizations to model different work types and billing structures within a single project. Offerings help align sales, delivery, and operations teams around specific scopes of work and resourcing needs.

Operations

Projects

A Project represents a distinct engagement or scope of work that the organization is delivering for a Client. Projects serve as containers for Project Offerings.

Operations

RateCardRates

Rate Card Rates represent the billable rates for specific roles within a Rate Card.

Operations

RateCards

A Rate Card represents a list of roles with a standard bill rate for each role.

Operations

Roles

A Role defines the type of work or skill set associated with resource assignments to project offerings. Roles are used to categorize resources, shape staffing needs, and support forecasting by identifying which types of personnel are required for each project offering.

Operations

Stages

A Pipeline Stage represents a single stage within the Pipeline, mapping directly to the stages defined in the system. Pipeline Stages allow for real-time visibility into opportunity status and expected resource demand throughout the sales process.

Operations

Tags

A Tag is a flexible metadata label used to categorize and filter entities such as People, Projects, and Project Offering Roles. Tags support custom grouping, reporting, and segmentation across multiple areas of the platform, enabling organizations to adapt Parallax to their internal business structures and workflows.

Operations

TimesheetEntries

Timesheet Entries represent time recorded within the Parallax Timesheets service, including additional properties related approval state.

Operations

WebhookSubscribers

Webhook configurations enable organizations to receive real-time event notifications via HTTP callbacks. Organizations can configure a single webhook endpoint to receive notifications about events such as project or offering, creation or changes. Each webhook includes a secret key for validating the authenticity of incoming requests.Only one Webhook Subscriber is currently allowed per organization.

Operations

Schemas

Schemas

UpdateProject

namestring or null

The name of the Project, typically describing the work engagement or scope for the Client.

statusobject or null(ProjectStatus)

Initial status for the Project. Default is pre_sale.

start_datestring or null(date)

The scheduled start date for the Project’s resource plan.

end_datestring or null(date)

The scheduled end date for the Project’s resource plan.

target_marginnumber or null(double)

Target margin for the Project. Defaults to Organization's target margin.

target_budgetobject or null(Money)

The target budget for the Project, representing the expected revenue from the Client.

archivedboolean or null

Indicates whether the Project is archived and no longer active for delivery or planning.

client_idstring or null(uuid)

Id of the Client associated with this Project.

stage_idstring or null(uuid)

Id of the Project's current Pipeline Stage.

tagsArray of strings or null

A list of tags assigned to the Project for filtering, categorization, or reporting.

project_modelobject or null(ProjectModel)

Project model. Default is client.

is_includedboolean or null

Manual flag to hide Projects from reports while keeping them visible in the UI.

{
  "name": "string",
  "status": {},
  "start_date": "2019-08-24",
  "end_date": "2019-08-24",
  "target_margin": 0.1,
  "target_budget": {
    "currency_code": "string",
    "amount": 0
  },
  "archived": true,
  "client_id": "5b3fa7ba-57d3-4017-a65b-d57dcd2db643",
  "stage_id": "f38d2b9c-0a0a-4eea-91a8-e974413bb670",
  "tags": [
    "string"
  ],
  "project_model": {},
  "is_included": true
}

UpdateProjectOffering

namestring or null

The new name for the Project Offering.

billing_modelobject or null(BillingModel)

The new Billing Model for the Project Offering. This cannot be updated for a project offering that is In Progress

billing_model_options(BillingModelOptionsFixedBid (object or null)) or (BillingModelOptionsRetainer (object or null)) or (BillingModelOptionsTimeMaterials (object or null))

Additional Billing Model configuration for the Project Offering.

One of:

Additional Billing Model configuration for the Project Offering.

{
  "name": "string",
  "billing_model": {},
  "billing_model_options": {
    "service_fee": { … },
    "billing_model": {}
  }
}

UpdateProjectOfferingRole

role_idstring or null(uuid)

Id of the organization Role that will be performing work on this ProjectOffering.

assignmentobject or null(Assignment)

Assignment of a Person or Requisition to this role. Set to null to unassign. Note: Removing or replacing an assignment where the person has actuals will return a 409 Conflict. The person must first be reassigned to another role or have their actuals removed.

should_clear_assignmentbooleanread-only
tagsArray of strings or null

List of tags to associate with this Project Offering Role. When provided, this completely replaces existing tags. Provide an empty array to clear all tags. Omit this property to leave tags unchanged.

{
  "role_id": "ac4e70c8-d5be-48af-93eb-760f58fc91a9",
  "assignment": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "type": {}
  },
  "should_clear_assignment": true,
  "tags": [
    "string"
  ]
}