PlanRadar Report Templates V2 API

openapi: 3.2.0
info:
  title: PlanRadar's API Documentation Approval Requests V2 Report Templates 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.<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: Report Templates V2
  description: Get all the report templates of your account in order to be able to export tickets with them
paths:
  /api/v2/{customer_id}/report_templates:
    get:
      summary: Returns all report templates
      tags:
      - Report Templates V2
      description: "This API returns all report templates of a customer. Report templates can be of type PDF or XLS\n      Extra parameters can be added to filter and sort the results.<br />\n      <b>Report Template Sorting:</b>\n      The results can be sorted by name, creation time or creator\n      The sort is always ascending unless the field name is prefixed with a minus i.e. -created-at\n      <br /><b>Example#1: </b>Sorting report templates by the creator\n      `/report_templates?sort=created-by`\n      <br /><b>Example#2: </b>Sorting report templates by descending creation time\n       `/report_templates?sort=-created-at`\n       <br /><b>Report Template Filtering:</b>\n      The results can be filtered by template type 0: PDF templates, 1: XLS templates\n      If type is left empty all types of templates will be returned.<br />\n      <b>Example:</b>\n      `/report_templates?type=0`<br />\n      "
      security:
      - apiKey: []
      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 report templates 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 report templates 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 report templates
        schema:
          type: string
      - name: type
        in: query
        description: limits the response to a specific template type
        schema:
          type: string
      responses:
        '404':
          description: Report Templates Not Found
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/