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.
Parallax Api (v1)
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
Overview
License
Languages
Servers
Mock server
https://developer.getparallax.com/_mock/api-documentation/swagger/
Production Server
https://api.getparallax.com/
The API can be accessed by creating a Personal Access Token in the Parallax application.
Personal Access Tokens, once generated, will need to be copied and saved somewhere safe. You will not be able to see the Personal Access Token again after generating. In the event you forget to copy/lose the token, you'll need to create a new one.
Once generated, Personal Access Tokens can be sent in the X-API-KEY header. Each request will require the Personal Access Token to access the API.
We had formerly documented Authorization: Bearer here, but we will reserve that for future use with OAuth/JWTs. Please use the X-API-KEY header for Personal Access Tokens.
Parallax enforces rate limits to ensure reliability and fair usage. We maintain the flexibility to adjust the limitations as needed, ensuring they are always set high enough to support the proper functioning of a well-behaved interactive program.
Parallax API uses a Fixed Window strategy, allowing a limited number of requests within a defined time window per user. If this limit is exceeded, the API will return a 429 Too Many Requests response, along with a Retry-After header indicating when it's safe to retry.
- Rate Limit set to 100 requests within a 60 second window
We recommend clients respect the Retry-After header and implement exponential backoff or retry logic accordingly.
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
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
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