PlanRadar List 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-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 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
description: Get the lists that you defined in your account
paths:
/api/v1/{customer_id}/lists/:
post:
summary: Creates new list
tags:
- List
security:
- apiKey: []
description: This API is used for creating a list with or without entries.
parameters:
- name: customer_id
in: path
required: true
schema:
type: string
responses:
'406':
description: Unsupported Accept Header
requestBody:
content:
application/json:
schema:
type: object
properties:
data:
type: object
properties:
attributes:
$ref: '#/components/schemas/List'
included:
type: array
description: array of the list entries
items:
type: object
properties:
type:
type: string
example: list-entries
attributes:
$ref: '#/components/schemas/Entry'
description: 'The only allowed value for type is ''list-entries'' '
operationId: postApiV1ByCustomerIdLists
x-operation-id-source: derived
get:
summary: Returns all lists
tags:
- List
description: 'This API returns all lists created by the logged in costumer.
List Sorting:
Lists can be sorted by their attributes like name and creation date: created-at. The sort is always ascending unless the field name is prefixed with a minus (U+002D HYPHEN-MINUS, "-") i.e. `-id` or `id`
Example#1: sorting lists by descending name `/lists?sort=-name`
Example#2: sorting lists by ascending creation date `/lists?sort=created-at`'
parameters:
- name: customer_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: sort
in: query
schema:
type: string
- 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: string
- name: page
in: query
description: sets the number of pages for the returned lists
schema:
type: string
responses:
'404':
description: Lists Not Found
'406':
description: Unsupported Accept Header
operationId: getApiV1ByCustomerIdLists
x-operation-id-source: derived
/api/v1/{customer_id}/lists/{id}:
get:
summary: Retrieve one list
tags:
- List
parameters:
- name: customer_id
in: path
required: true
schema:
type: string
- name: id
in: path
required: true
schema:
type: string
responses:
'404':
description: List Not Found
operationId: getApiV1ByCustomerIdListsById
x-operation-id-source: derived
put:
summary: Updates specific list
tags:
- List
description: This API is used for updating a specific list with or without entries based on its id.
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:
$ref: '#/components/schemas/List'
included:
type: array
description: array of the list entries
items:
type: object
properties:
type:
type: string
example: list-entries
attributes:
$ref: '#/components/schemas/Entry'
description: 'The only allowed value for type is ''list-entries'' '
operationId: putApiV1ByCustomerIdListsById
x-operation-id-source: derived
patch:
summary: Update one list with/out list entries
tags:
- List
security:
- apiKey: []
parameters:
- name: customer_id
in: path
required: true
schema:
type: string
- name: list_id
in: path
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
customer-id:
type: string
included:
type: array
items:
type: object
properties:
type:
type: string
attributes:
type: object
properties:
name:
type: string
uuid:
type: string
operationId: patchApiV1ByCustomerIdListsById
x-operation-id-source: derived
delete:
summary: Deletes specific list
tags:
- List
description: This API is used for deleting a specific list based on its id.
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:
'404':
description: List Not Found
operationId: deleteApiV1ByCustomerIdListsById
x-operation-id-source: derived
components:
schemas:
Entry:
type: object
description: -- is optional since a list can be without entries
properties:
name:
type: string
description: name of the list entry
uuid:
type: string
description: unique identifier of the list entry - is optional
parent_id:
type: integer
description: entry parent id
order:
type: integer
description: order for each entry
List:
type: object
properties:
name:
type: string
example: newlist
description: name of the list - is required
customer-id:
type: string
description: id of the logged in customer
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/