Skip to content

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

List Projects

Request

Gets a paginated list of Projects in the system, including client and internal projects, for comprehensive visibility across your portfolio.

Security
ApiKey
Query
external_idstring

Filter by external ID. For Parallax-managed integrations, use the format 'px_provider:id' (e.g., 'px_hubspot:12345'). For custom integrations, use the string format appropriate for that integration.

sales_owner_idstring, (uuid)

Filter by the Id of the Person who owns the sale of the Project.

project_owner_idstring, (uuid)

Filter by the Id of the Person who owns the Project.

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/projects?external_id=string&sales_owner_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&project_owner_id=497f6eca-6276-4993-bfeb-53cbbbba6f08&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(Project)required

The array of result objects for the current page.

Response
{
  "count": 0,
  "total": 0,
  "page": 0,
  "total_pages": 0,
  "page_size": 0,
  "results": [
    { … }
  ]
}