HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Actions290

Project → Get by ID

AI-generated

Summary

Retrieves a single project record by its ID, optionally including attachments, custom fields, and detailed related objects.

Inputs

  • projectId (required) — The ID of the project to retrieve.
  • options — A collection of toggle options to control response payload depth.
  • optionsJson — Dynamic options as a JSON object to override or supplement the Options collection. Supports expressions.

Output shape

a single record item

The shape of the returned item matches the HaloPSA Project object structure. Enabling options may add nested objects (attachments, custom fields, etc.).

Examples

Example 1: Retrieve basic project details

Set Project ID and leave options empty.

Example 2: Retrieve project with full details and attachments

Set Project ID, enable Include Attachments, Include Custom Fields, and Include Details in options.

Example 3: Override options dynamically

Set Project ID and use optionsJson to dynamically include specific fields via expression.

Links

Discussion