PlanRadar List API
Get the lists that you defined in your account
Get the lists that you defined in your account
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/planradar-list-api"
curl "https://apis.io/api/v1/apis?limit=25"
Discovery needs no key. Ratings and market analysis are Pro.
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: 3.2.0
info:
title: PlanRadar's API Documentation Approval Requests V2 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.<br />\n <h5>Rate Limits</h5>30 requests per minute per account, aggregated across all tokens.<br />\n If the threshold is exceeded, a 5-minute cooldown is applied to the account, aggregated across all tokens.<br />\n During the cooldown period, further requests may be rejected until the cooldown ends.<br />\n In rare cases, an endpoint may have a different rate limit than the default. When that happens, the differing limit will be explicitly stated in the API documentation for that endpoint.<br />\n <h5>Access Key</h5>In order to be able to access any API you have to create an access token.Therefore you have to follow these steps:-\n <ul>\n <li>Go to your profile page and click on Personal Access Tokens on the left side bar</li><li>Click on the 'Create Access Token' top right button in order to create a new access token.</li><li>Copy the created token and paste it into the field that pops up when you click on the 'Authorize' button </li><li>Note: you can copy the token only once.</li><li>Now you can easily access any API</li>\n </ul>\n <h5>V2 APIs</h5>We are currently working on upgrading all our APIs to v2, and we recommend that you use v2 APIs if it is available.\n <p>V2 APIs are faster, robust and more flexible than v1 APIs</p>"
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'' '
get:
summary: Returns all lists
tags:
- List
description: 'This API returns all lists created by the logged in costumer.<br ><b>List Sorting: </b> <br /> 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` <br /><b>Example#1: </b>sorting lists by descending name `/lists?sort=-name`<br /><b>Example#2: </b>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
/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
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'' '
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
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
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/