PlanRadar List V2 API
Get the lists that you defined in your account
Work with this as data
Every API here is available over the APIs.io API and to AI agents over MCP.
MCP server
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
Tools for apis
7 MCP tools reach this
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.
Call it yourself
curl for this page
This API
curl "https://apis.io/api/v1/apis/planradar:planradar-list-v2-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
OpenAPI Specification
openapi: 3.2.0
info:
title: PlanRadar's API Documentation List V2 API
version: '2.0'
description: Welcome to PlanRadar's API documentation, here you can find all the details about our APIs as well as test them online.
servers:
- url: /
tags:
- name: List V2
description: Get the lists that you defined in your account
paths:
/api/v2/{customer_id}/lists/{id}:
put:
summary: Updates specific list
tags:
- List V2
description: 'Updates a specific list by its id. This endpoint uses a draft-based workflow that requires 3 sequential requests with the same temp-uuid:
**Step 1 - Initialize draft:** Send `init_draft: true` with a client-generated `temp-uuid` to copy existing entries into a draft table.
**Step 2 - Modify entries:** Send one or more requests with the same `temp-uuid` to add, update, or delete entries in the draft.
- To add/update an entry: include an `item` object with `name`, `uuid`, `parent-id`, and `order`.
- To delete an entry: include `entry-uuid` with the UUID of the entry to remove.
**Step 3 - Save changes:** Send `save: true` with the same `temp-uuid` to persist the draft changes to the actual list.
The `temp-uuid` must be a valid UUID and unique for each update session. It is generated by the client.
---
**curl Examples:**
**Step 1 — Initialize draft:**
curl -X PUT "https://app.planradar.com/api/v2/{customer_id}/lists/{list_id}" \
-H "X-PlanRadar-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d ''{
"data": {
"attributes": {
"temp-uuid": "c7982fd2-cf0c-4806-a3ef-f87447e80e5f",
"init_draft": true
}
}
}''
**Step 2 — Add a new entry:**
curl -X PUT "https://app.planradar.com/api/v2/{customer_id}/lists/{list_id}" \
-H "X-PlanRadar-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d ''{
"data": {
"attributes": {
"temp-uuid": "c7982fd2-cf0c-4806-a3ef-f87447e80e5f",
"item": {
"name": "New Entry",
"uuid": "5101ebd3-922c-4830-85aa-b7b6be97d2ca",
"parent-id": null,
"order": 0
}
}
}
}''
**Step 3 — Save changes:**
curl -X PUT "https://app.planradar.com/api/v2/{customer_id}/lists/{list_id}" \
-H "X-PlanRadar-API-Key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d ''{
"data": {
"attributes": {
"temp-uuid": "c7982fd2-cf0c-4806-a3ef-f87447e80e5f",
"save": true
}
}
}'''
security:
- apiKey: []
parameters:
- name: customer_id
in: path
required: true
schema:
type: string
- name: id
in: path
description: id of the list
required: true
schema:
type: string
responses:
'406':
description: Unsupported Accept Header
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
attributes:
type: object
properties:
name:
type: string
description: Name of the list
temp-uuid:
type: string
format: uuid
description: Client-generated UUID, must be unique per update session
example: c7982fd2-cf0c-4806-a3ef-f87447e80e5f
init_draft:
type: boolean
description: Set to true to initialize a draft from the current list entries (Step 1)
save:
type: boolean
description: Set to true to persist draft changes to the actual list (Step 3)
item:
type: object
description: A single entry to add or update in the draft (Step 2)
properties:
id:
type: string
description: Entry UUID, required when updating an existing entry
name:
type: string
description: Name of the entry
uuid:
type: string
format: uuid
description: Client-generated UUID for a new entry
parent-id:
type:
- string
- 'null'
description: UUID of the parent entry for hierarchical lists, null for root entries
order:
type: integer
description: Position/order of the entry in the list
entry-uuid:
type: string
description: UUID of the entry to delete from the draft (Step 2)
operationId: putApiV2ByCustomerIdListsById
x-operation-id-source: derived
/api/v2/{customer_id}/projects/{project_id}/ticket_types/lists/:
get:
summary: Returns all lists of a specific project
tags:
- List V2
description: This API returns all lists that are attached to the ticket types that are used by a specific project based on its id.
parameters:
- name: customer_id
in: path
required: true
schema:
type: string
- name: project_id
in: path
required: true
schema:
type: string
- name: last_sync_date
in: query
description: is a Unix Timestamp. If it is set, only lists that were created after that timestamp will be returned
schema:
type: string
- name: page
in: query
description: ' sets the number of pages for the returned lists'
schema:
type: integer
- name: pagesize
in: query
description: ' sets the number of lists that should be returned per page<br/>Maximum is 500, default is 100'
schema:
type: integer
- name: disable_relations
in: query
description: ' Returns only the ticket_type_lists without loading the list entries, which would make the API faster '
schema:
type: boolean
responses:
'404':
description: Lists Not Found
'406':
description: Unsupported Accept Header
operationId: getApiV2ByCustomerIdProjectsByProjectIdTicketTypesLists
x-operation-id-source: derived
components:
securitySchemes:
apiKey:
type: apiKey
name: X-PlanRadar-API-Key
in: header
externalDocs:
description: Find out more about our development portal
url: https://www.planradar.com/knowledge-base-overview/