Working with PlanRadar Data

What You'll Learn

By the end of this article, you'll understand how PlanRadar structures its API responses, how to locate and work with custom fields (typed values), and why certain data — like project custom fields — requires additional API calls to retrieve.

Understanding the Data Structure

PlanRadar returns data as JSON objects. Before you can map data between steps in a recipe, you need to understand how these objects are organised.

Key things to know:

• All PlanRadar objects (tickets, projects, users, etc.) are returned under a top-level data attribute, with fields nested under attributes.

• Objects have IDs which look like aqbqod — used in API calls or 1234 — used in the UI

• Specifically for ticket objects, the field called subject in the API response corresponds to the Title field visible in the PlanRadar interface.

• Ticket statuses have letter-based ids in API responses (e.g. lm for Open).

Custom Fields (Typed Values)

Custom fields on tickets are returned under typed_values in the API response. Each custom field has a unique field id that persists even if the field is renamed in the PlanRadar UI.

How to work with custom fields

1. Find the field id by calling the Get Ticket Types API endpoint. This returns all forms and their associated custom field ids and display names.

2. Reference custom fields by their id in recipe conditions and actions — never by display name, as names can change.

3. If a custom field uses a dropdown list, each list option also has its own id. Find these by inspecting the ticket API response after a value has been selected.

⚠️ Warning: In project objects, empty custom fields are not returned

Project custom fields are only included in an API response if they contain a value. If a field is empty, it will not appear in the response at all.

This means you must always check whether a field is present in the response before attempting to evaluate its value. If you skip this check and the field is absent, your recipe will throw an error for every ticket or project where that field is empty.

Pattern to follow: Add a condition step that checks for the field's presence before any step that reads its value.

Text Mode vs. Formula Mode

Every input field in PlanRadar Connect operates in one of two modes:

Toggle between modes per field individually. Use formula mode when you need string manipulation, or data transformations that text mode cannot handle.

Response schema can go stale

If you add new custom fields or change the schema of a PlanRadar object after the recipe was built, the response schema in your recipe may become outdated. Refresh it by pasting the sample JSON schema into the HTTP request > Response schema