PlanRadar Roles API

swagger: '2.0'
info:
  title: PlanRadar's API Documentation Approval Requests V2 Roles 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>"
basePath: /
schemes:
- https
- http
consumes:
- application/json
produces:
- application/json
tags:
- name: Roles
  description: Get the roles that you have defined in your account
paths:
  /api/v1/{customer_id}/roles:
    get:
      summary: Returns all roles
      tags:
      - Roles
      description: 'This API returns all roles that were created by the logged in customer. Without any extra parameters it will return the first 100 roles ordered by ascending ID. Extra parameters can be added to sort the results.<br /><b>Role Sorting</b> Roles can be sorted by their attributes like id, name, creation date: created-on and whether a role is an admin role: is-admin-role. 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> `/roles?sort=-id`<br /><b>Example#2: </b> `/roles?sort=created-on`<br />'
      security:
      - apiKey: []
      produces:
      - application/json
      parameters:
      - name: customer_id
        in: path
        type: string
        required: true
      - name: page
        in: query
        type: integer
        description: sets the number of pages for the returned roles
      - name: pagesize
        in: query
        type: integer
        description: sets the number of roles that should be returned per page <br> Maximum is 500, default is 100
      - name: last_sync_date
        in: query
        type: string
        description: is a Unix Timestamp. If it is set, only roles that were created after that timestamp will be returned
      - name: search
        in: query
        type: string
        description: ' keyword, based on which the roles will be filtered'
      - name: sort
        in: query
        type: string
      responses:
        '404':
          description: Not Found
securityDefinitions:
  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/