Skip to content
/
Create Project Offering.

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

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
curl -i -X GET \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/projects/{project_id}/offerings?page=0&page_size=0&terms=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
application/json
{
  "count": 0,
  "total": 0,
  "page": 0,
  "total_pages": 0,
  "page_size": 0,
  "results": [
    { … }
  ]
}

Create Project Offering.

Request

Creates a new Project Offering for the specified Project. Additional configuration for certain Billing Models are optional.

Security
ApiKey
Path
project_idstring(uuid)required

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

Body
namestringrequired

The name for the Project Offering.

billing_modelobject(BillingModel)required

The Billing Model for the Project Offering.

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.

curl -i -X POST \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/projects/{project_id}/offerings' \
  -H 'Content-Type: application/json-patch+json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "name": "string",
    "billing_model": {},
    "billing_model_options": {
      "service_fee": {
        "currency_code": "string",
        "amount": 0
      },
      "billing_model": {}
    }
  }'

Responses

Created

Bodyapplication/json
idstring(uuid)required

The unique identifier for the Project Offering.

namestringrequired

The name of the Project Offering.

billing_modelobject(BillingModel)required

The billing model applied to the Project Offering. This is restricted by the Project's Project Type. Client projects support Time & Materials, Fixed Bid, and Fixed Retainer billing models while Internal projects only allow Investment and Admin models

billing_model_optionsBillingModelOptionsFixedBid (object) or BillingModelOptionsRetainer (object) or BillingModelOptionsTimeMaterials (object)required

Additional Billing Model configuration for the Project Offering.

One of:

Additional Billing Model configuration for the Project Offering.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "billing_model": {},
  "billing_model_options": {
    "service_fee": { … },
    "billing_model": {}
  }
}

Get Project Offering

Request

Gets details of a specific Project Offering, including financial settings, planned roles, and associated timesheet project.

Security
ApiKey
Path
idstring(uuid)required

ID of the resource

project_idstring(uuid)required

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

curl -i -X GET \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/projects/{project_id}/offerings/{id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json
idstring(uuid)required

The unique identifier for the Project Offering.

namestringrequired

The name of the Project Offering.

billing_modelobject(BillingModel)required

The billing model applied to the Project Offering. This is restricted by the Project's Project Type. Client projects support Time & Materials, Fixed Bid, and Fixed Retainer billing models while Internal projects only allow Investment and Admin models

billing_model_optionsBillingModelOptionsFixedBid (object) or BillingModelOptionsRetainer (object) or BillingModelOptionsTimeMaterials (object)required

Additional Billing Model configuration for the Project Offering.

One of:

Additional Billing Model configuration for the Project Offering.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "billing_model": {},
  "billing_model_options": {
    "service_fee": { … },
    "billing_model": {}
  }
}

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