HaloPSA Complete icon

HaloPSA Complete

Get data from the HaloPSA API

Actions290

Client → Get by ID

AI-generated

Summary

Retrieve detailed information about a client by its ID, optionally including additional data such as domain filters, ticket types, activity, details, periods, and prepay information.

Inputs

  • Client ID (required) — The ID of the client to retrieve.
  • Additional Fields — Optional parameters to customize the response, including domain filtering, whether to include available ticket types, customer ticket activity, extra detailed objects, pre-pay periods, pre-pay information, and filtering by ticket type ID.

Output shape

A single client record with included details according to specified additional fields.

The response shape depends on the specified additional fields; for example, including ticket types or activity data will alter the returned data structure accordingly.

Examples

Example 1: Fetch client data by ID with default fields only.

Set 'Client ID' with the target client ID; leave additional fields empty.

Example 2: Fetch client data including available ticket types and detailed information.

Set 'Client ID' and in 'Additional Fields' enable 'Get Available RTs' and 'Include Details'.

Links

Discussion