Skip to content
/ActualTime

Parallax Api (v1)

The Parallax API allows developers to integrate with core platform data related to clients, projects, and opportunities. It is primarily designed to support CRM integrations, enabling systems to push and pull data in and out of Parallax for better visibility and coordination.The API uses standard REST principles, with JSON responses and token-based authentication. It is versioned and designed to expand over time.A timesheet API is planned for future versions, which will support time entry, reporting, and resource planning features.

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

List Actual Time

Request

Gets a paginated list of actual time entries with optional filtering by date range, project offering, and person. When no start or end date filters are provided, returns entries from the last 7 days (7 days ago through today).

Security
ApiKey
Query
pageinteger(int32)

The specific page of results requested.

page_sizeinteger(int32)

The number of results in each page.

start_datestring(date)

Filter by entries recorded on or after this date. When not provided, defaults to 7 days ago from today. ISO date formatting expected (yyyy-MM-dd)

end_datestring(date)

Filter by entries recorded on or before this date. When not provided, defaults to today. ISO date formatting expected (yyyy-MM-dd)

project_offering_idstring(uuid)

The id of the project offering in which the actual time entry belongs to.

person_idstring(uuid)

The id of the Person to which the actual time entry belongs. If a person is specified who does not currently have a role on the project, a new ProjectOfferingRole will be created using the person's default organization role. The person will be assigned to it, and the ActualTime entry will be attached.

curl -i -X GET \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/actual-time?page=0&page_size=0&start_date=2019-08-24&end_date=2019-08-24&project_offering_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&person_id=497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -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(ActualTime)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 Actual Time

Request

Creates a new record representing hours a person has logged to a project, typically synced from the Timesheet System for tracking actuals against planned work. Parallax only allows a person to have a single role on a project offering, which means that the role is inferred by project_offering_id.

Security
ApiKey
Body
project_idstring(uuid)required

The id of the project that the actual time is being recorded for.

project_offering_idstring(uuid)required

The id of the project offering in which the actual time entry belongs to.

person_idstring(uuid)required

The id of the Person to which the actual time entry belongs. If a person is specified who does not currently have a role on the project, a new ProjectOfferingRole will be created using the person's default organization role. The person will be assigned to it, and the ActualTime entry will be attached.

descriptionstring or null

Notes associated with the actual time entry.

recorded_datestring(date)required

The date in which the actual time entry is recorded to, in the YYYY-MM-DD format.

hoursnumber(double)required

The number of hours associated with the actual time entry.

billablebooleanrequired

Indicates whether the actual time entry was for billable work.

curl -i -X POST \
  https://developer.getparallax.com/_mock/api-documentation/swagger/v1/actual-time \
  -H 'Content-Type: application/json-patch+json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
    "project_offering_id": "7dfed78d-ddbe-4f81-b7b1-e4094f9ff440",
    "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
    "description": "string",
    "recorded_date": "2019-08-24",
    "hours": 0.1,
    "billable": true
  }'

Responses

Created

Bodyapplication/json
idstring(uuid)

The id of the actual time entry

project_idstring(uuid)

The id of the project that the actual time is being recorded for.

project_offering_idstring(uuid)

The id of the project offering in which the actual time entry belongs to.

project_offering_role_idstring(uuid)

The id of the project offering role that the actual time is recorded to.

person_idstring(uuid)

The id of the Person to which the actual time entry belongs. If a person is specified who does not currently have a role on the project, a new ProjectOfferingRole will be created using the person's default organization role. The person will be assigned to it, and the ActualTime entry will be attached.

descriptionstring or null

Notes associated with the actual time entry.

recorded_datestring(date)

The date in which the actual time entry is recorded to, in the YYYY-MM-DD format.

hoursnumber(double)

The number of hours associated with the actual time entry.

billableboolean

Indicates whether the actual time entry was for billable work.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "project_offering_id": "7dfed78d-ddbe-4f81-b7b1-e4094f9ff440",
  "project_offering_role_id": "7e0533b8-5407-48c5-9bcc-a30f3092a3e8",
  "person_id": "087e858e-473c-4f50-b5b0-c1df6c021550",
  "description": "string",
  "recorded_date": "2019-08-24",
  "hours": 0.1,
  "billable": true
}

Delete Actual Time

Request

Removes a recorded entry of hours worked from the system, typically used for error correction or cleanup.

Security
ApiKey
Path
idstring(uuid)required

ID of the resource

curl -i -X DELETE \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/actual-time/{id}' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE'

Responses

No Content

Response
No content

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 Service 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 (Service 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 Service Offerings, resource plans, financial models, and delivery data.

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 across projects and offerings. Roles are used to categorize resources, shape staffing needs, and support forecasting by identifying which types of personnel are required for each project or service 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

Schemas

Schemas