PlanRadar Export API

Export tickets as Excel or PDF files

Operations 5

GET /api/v1/{customer_id}/projects/{project_id}/tickets/export/xls Export Tickets as an Excel File #
POST /api/v1/{customer_id}/projects/{project_id}/tickets/export/xls Export Tickets as an Excel File using POST #
GET /api/v1/{customer_id}/projects/{project_id}/tickets/export/pdf Export Tickets as a PDF File #
POST /api/v1/{customer_id}/projects/{project_id}/tickets/export/pdf Export Tickets as a PDF File with POST request #
GET /api/{customer_id}/check_if_finished/{uuid} Check if export is finished #

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.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/planradar:planradar-export-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

planradar-export-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: PlanRadar's API Documentation Export 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: Export
  description: Export tickets as Excel or PDF files
paths:
  /api/v1/{customer_id}/projects/{project_id}/tickets/export/xls:
    get:
      summary: Export Tickets as an Excel File
      tags:
      - Export
      description: By default it will export all the tickets, if filters added, it will only export filtered data
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
      - name: project_id
        in: path
        required: true
        schema:
          type: string
      - name: filter
        in: query
        description: 'Used to filter tickets based on any conditions of the related model, filter[author_id]=1 will list all tickets related to this author id, similar to filter[author.id]=1, the second one will use the condition based on the user table such a filter is available filter[author.email]=test@email.com, for multiple values for the same filter use filter[id][]=PN&filter[id][]=nE,,,, available models are: customer, ticket_type, project, component, status, ticket, author, assigned_to, updated_by'
        schema:
          type: string
      - name: apply_filter
        in: query
        description: ID of the custom filter to be applied before returning the data
        schema:
          type: string
      - name: timezone_offset
        in: query
        schema:
          type: string
      responses:
        '406':
          description: unsupported accept header
      operationId: getApiV1ByCustomerIdProjectsByProjectIdTicketsExportXls
      x-operation-id-source: derived
    post:
      summary: Export Tickets as an Excel File using POST
      tags:
      - Export
      description: 'Export tickets as Excel file. by default it will export all tickets matching the provided filter, if no filter is provided all tickets will be exported


        Check ticket loading API for more details about the filters that can be provided'
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
      - name: project_id
        in: path
        required: true
        schema:
          type: string
      - name: template_id
        in: query
        description: ID of the template to be used for the export
        schema:
          type: string
      - name: apply_filter
        in: query
        description: ID of the custom filter to be applied before returning the data
        schema:
          type: string
      responses:
        '406':
          description: unsupported accept header
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                filter:
                  type: object
                  properties:
                    uuid:
                      type: array
                      items:
                        type: string
        description: Check ticket load API, for a detailed description of the filter object
      operationId: postApiV1ByCustomerIdProjectsByProjectIdTicketsExportXls
      x-operation-id-source: derived
  /api/v1/{customer_id}/projects/{project_id}/tickets/export/pdf:
    get:
      summary: Export Tickets as a PDF File
      tags:
      - Export
      description: 'By default it will export all the tickets, if filters added, it will only export filtered data, ticket will be added with a job, id of the job will be returned or an error message

        timezone_offset


        Is used to convert all dates included in the PDF document to the correct timezone. the value should be the difference in minutes between UTC and your location.'
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
      - name: project_id
        in: path
        required: true
        schema:
          type: string
      - name: filter
        in: query
        description: 'Used to filter tickets based on any conditions of the related model, filter[author_id]=1 will list all tickets related to this author id, similar to filter[author.id]=1, the second one will use the condition based on the user table such a filter is available filter[author.email]=test@email.com, for multiple values for the same filter use filter[id][]=PN&filter[id][]=nE,,,, available models are: customer, ticket_type, project, component, status, ticket, author, assigned_to, updated_by'
        schema:
          type: string
      - name: apply_filter
        in: query
        description: ID of the custom filter to be applied before returning the data
        schema:
          type: string
      - name: template_id
        in: query
        description: ID of the template to be used for the export OPTIONAL
        schema:
          type: string
      - name: timezone_offset
        in: query
        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:
                        filter:
                          type: object
                          properties:
                            uuid:
                              type: array
                              items:
                                type: string
                        template-id:
                          type: string
      operationId: getApiV1ByCustomerIdProjectsByProjectIdTicketsExportPdf
      x-operation-id-source: derived
    post:
      summary: Export Tickets as a PDF File with POST request
      tags:
      - Export
      description: 'By default it will export all the tickets, if filters added, it will only export filtered data, ticket will be added with a job, id of the job will be returned or an error message

        timezone_offset


        Is used to convert all dates included in the PDF document to the correct timezone. the value should be the difference in minutes between UTC and your location.'
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
      - name: project_id
        in: path
        required: true
        schema:
          type: string
      - name: apply_filter
        in: query
        description: ID of the custom filter to be applied before returning the data
        schema:
          type: string
      - name: template_id
        in: query
        description: ID of the template to be used for the export
        schema:
          type: string
      - name: timezone_offset
        in: query
        schema:
          type: string
      responses:
        '406':
          description: unsupported accept header
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                filter:
                  type: object
                  properties:
                    uuid:
                      type: array
                      items:
                        type: string
        description: Check ticket load API, for a detailed description of the filter object
      operationId: postApiV1ByCustomerIdProjectsByProjectIdTicketsExportPdf
      x-operation-id-source: derived
  /api/{customer_id}/check_if_finished/{uuid}:
    get:
      summary: Check if export is finished
      tags:
      - Export
      description: Polls the status of an asynchronous export identified by `uuid`. Returns the export metadata once it is ready. Pass `direct_url=true` to additionally receive a short-lived pre-signed S3 URL in the response (`direct_url` field) that lets the client download the exported file directly, without going through the `/download` redirect endpoint. The pre-signed URL is only generated for export types `pdf`, `single_pdf`, `xls`, `csv` (when the file exists in S3) and `zip`.
      security:
      - apiKey: []
      parameters:
      - name: customer_id
        in: path
        required: true
        schema:
          type: string
      - name: uuid
        in: path
        required: true
        description: UUID of the export job (returned when the export was triggered).
        schema:
          type: string
      - name: direct_url
        in: query
        required: false
        description: 'When `true`, the response includes a `direct_url` field containing a short-lived pre-signed S3 URL for direct download. Supported export types: `pdf`, `single_pdf`, `xls`, `csv`, `zip`. Omit (or set `false`) to receive only the standard export metadata.'
        schema:
          type: boolean
      responses:
        '404':
          description: Not Found
      operationId: getApiByCustomerIdCheckIfFinishedByUuid
      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/