Skip to content
/Roles

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

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

List Roles

Request

Returns paginated list of defined roles used in shaping resource plans, typically categorized by department and used to match people to work.

Security
ApiKey
Query
pageinteger(int32)

The specific page of results requested.

page_sizeinteger(int32)

The number of results in each page.

archivedboolean

Indicates if results should be filtered by their archived status.

curl -i -X GET \
  'https://developer.getparallax.com/_mock/api-documentation/swagger/v1/roles?page=0&page_size=0&archived=true' \
  -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(Role)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 Role

Request

Creates a new role within a department to be used for shaping, planning, and reporting.

Security
ApiKey
Body
department_idstring(uuid)required

The unique identifier of the Department that this Role belongs to for capacity and reporting segmentation.

namestringrequired

The name of the Role, typically describing the job function or skill set (e.g. Designer, Developer).

curl -i -X POST \
  https://developer.getparallax.com/_mock/api-documentation/swagger/v1/roles \
  -H 'Content-Type: application/json-patch+json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "department_id": "094fb5f1-8160-46ea-8cec-010c4b44e054",
    "name": "string"
  }'

Responses

Created

Bodyapplication/json
idstring(uuid)

The unique identifier for the Role in Parallax.

namestring

The name of the Role, typically describing the job function or skill set (e.g. Designer, Developer).

department_idstring(uuid)

The unique identifier of the Department that this Role belongs to for capacity and reporting segmentation.

capacitynumber(double)

The full-time capacity for this Role, expressed as a percentage (e.g. 1.0 = 100%).

billable_utilization_targetnumber(double)

The target percentage of billable utilization expected for this Role, expressed as a percentage (e.g. 1.0 = 100%).

archivedboolean

Indicates whether this Role has been archived and is no longer active for planning or reporting.

created_datestring(date-time)

The date and time when the Role record was created in Parallax.

modified_datestring(date-time)

The date and time when the Role record was last modified in Parallax.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "department_id": "094fb5f1-8160-46ea-8cec-010c4b44e054",
  "capacity": 0.1,
  "billable_utilization_target": 0.1,
  "archived": true,
  "created_date": "2019-08-24T14:15:22Z",
  "modified_date": "2019-08-24T14:15:22Z"
}

Get Role

Request

Gets details of a specific role used for shaping, planning, and reporting.

Security
ApiKey
Path
idstring(uuid)required

ID of the resource

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

Responses

OK

Bodyapplication/json
idstring(uuid)

The unique identifier for the Role in Parallax.

namestring

The name of the Role, typically describing the job function or skill set (e.g. Designer, Developer).

department_idstring(uuid)

The unique identifier of the Department that this Role belongs to for capacity and reporting segmentation.

capacitynumber(double)

The full-time capacity for this Role, expressed as a percentage (e.g. 1.0 = 100%).

billable_utilization_targetnumber(double)

The target percentage of billable utilization expected for this Role, expressed as a percentage (e.g. 1.0 = 100%).

archivedboolean

Indicates whether this Role has been archived and is no longer active for planning or reporting.

created_datestring(date-time)

The date and time when the Role record was created in Parallax.

modified_datestring(date-time)

The date and time when the Role record was last modified in Parallax.

Response
application/json
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "department_id": "094fb5f1-8160-46ea-8cec-010c4b44e054",
  "capacity": 0.1,
  "billable_utilization_target": 0.1,
  "archived": true,
  "created_date": "2019-08-24T14:15:22Z",
  "modified_date": "2019-08-24T14:15:22Z"
}

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